Package org.springframework.social.security.provider

Class OAuth2AuthenticationService<S>

java.lang.Object

org.springframework.social.security.provider.AbstractSocialAuthenticationService<S>

org.springframework.social.security.provider.OAuth2AuthenticationService<S>

Type Parameters:

S - The provider's API type.

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, SocialAuthenticationService<S>

public class OAuth2AuthenticationService<S>
extends AbstractSocialAuthenticationService<S>

Author:

Stefan Fussennegger

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.social.security.provider.SocialAuthenticationService

SocialAuthenticationService.ConnectionCardinality

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor	Description
OAuth2AuthenticationService(OAuth2ConnectionFactory<S> connectionFactory)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected String	buildReturnToUrl(javax.servlet.http.HttpServletRequest request)
SocialAuthenticationToken	getAuthToken(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	extract SocialAuthenticationToken from request
OAuth2ConnectionFactory<S>	getConnectionFactory()
Set<String>	getReturnToUrlParameters()
void	setConnectionFactory(OAuth2ConnectionFactory<S> connectionFactory)
void	setDefaultScope(String defaultScope)
void	setReturnToUrlParameters(Set<String> returnToUrlParameters)

Methods inherited from class org.springframework.social.security.provider.AbstractSocialAuthenticationService

getConnectionAddedRedirectUrl, getConnectionCardinality, setConnectionAddedRedirectUrl, setConnectionCardinality

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

OAuth2AuthenticationService

public OAuth2AuthenticationService(OAuth2ConnectionFactory<S> connectionFactory)

Method Detail

getConnectionFactory

public OAuth2ConnectionFactory<S> getConnectionFactory()

Returns:

ConnectionFactory used for authentication

setConnectionFactory

public void setConnectionFactory(OAuth2ConnectionFactory<S> connectionFactory)

setReturnToUrlParameters

public void setReturnToUrlParameters(Set<String> returnToUrlParameters)

getReturnToUrlParameters

public Set<String> getReturnToUrlParameters()

setDefaultScope

public void setDefaultScope(String defaultScope)

Parameters:

defaultScope - OAuth scope to use, i.e. requested permissions

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class AbstractSocialAuthenticationService<S>

Throws:

Exception

getAuthToken

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

Description copied from interface: SocialAuthenticationService

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

buildReturnToUrl

protected String buildReturnToUrl(javax.servlet.http.HttpServletRequest request)