org.springframework.social.security.provider

Interface SocialAuthenticationService<S>

Type Parameters:

S - The provider's API type.

All Known Implementing Classes:

AbstractSocialAuthenticationService, OAuth1AuthenticationService, OAuth2AuthenticationService

public interface SocialAuthenticationService<S>

Authentication for social ConnectionFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SocialAuthenticationService.ConnectionCardinality

Method Summary

Modifier and Type	Method and Description
SocialAuthenticationToken	getAuthToken(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) extract SocialAuthenticationToken from request
String	getConnectionAddedRedirectUrl(javax.servlet.http.HttpServletRequest request, Connection<?> connection)
SocialAuthenticationService.ConnectionCardinality	getConnectionCardinality()
ConnectionFactory<S>	getConnectionFactory()

Method Detail

getConnectionCardinality

SocialAuthenticationService.ConnectionCardinality getConnectionCardinality()

Returns:

SocialAuthenticationService.ConnectionCardinality for connections to this provider

getConnectionFactory

ConnectionFactory<S> getConnectionFactory()

Returns:

ConnectionFactory used for authentication

getAuthToken

SocialAuthenticationToken getAuthToken(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)
                                throws SocialAuthenticationRedirectException

extract SocialAuthenticationToken from request

Parameters:

request - current HttpServletRequest

response - current HttpServletResponse

Returns:

new unauthenticated token or null

Throws:

SocialAuthenticationRedirectException - if social auth requires a redirect, e.g. OAuth

getConnectionAddedRedirectUrl

String getConnectionAddedRedirectUrl(javax.servlet.http.HttpServletRequest request,
                                     Connection<?> connection)

Parameters:

request - current HttpServletRequest

connection - the connection from which to calculate the redirect URL

Returns:

null to use filter default