org.springframework.social.openid.security

Class OpenIdAuthenticationService

java.lang.Object

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

org.springframework.social.openid.security.OpenIdAuthenticationService

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, org.springframework.social.security.provider.SocialAuthenticationService<OpenId>

public class OpenIdAuthenticationService
extends org.springframework.social.security.provider.AbstractSocialAuthenticationService<OpenId>

Nested Class Summary

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

org.springframework.social.security.provider.SocialAuthenticationService.ConnectionCardinality

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CLAIMED_IDENTITY_FIELD

Constructor Summary

Constructors

Constructor and Description
OpenIdAuthenticationService()
OpenIdAuthenticationService(OpenIdConnectionFactory connectionFactory)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected String	buildReturnToUrl(javax.servlet.http.HttpServletRequest request) Builds the return_to URL that will be sent to the OpenID service provider.
org.springframework.social.security.SocialAuthenticationToken	getAuthToken(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
OpenIdConnectionFactory	getConnectionFactory()
IRealmMapper	getRealmMapper()
protected String	lookupRealm(String returnToUrl)
protected Map<String,String>	obtainAccountData(org.springframework.security.openid.OpenIDAuthenticationToken token)
protected String	obtainUsername(javax.servlet.http.HttpServletRequest req) Reads the claimedIdentityFieldName from the submitted request.
void	setClaimedIdentityFieldName(String claimedIdentityFieldName) The name of the request parameter containing the OpenID identity, as submitted from the initial login form.
void	setConnectionFactory(OpenIdConnectionFactory connectionFactory)
void	setConsumer(org.springframework.security.openid.OpenIDConsumer consumer)
void	setRealmMapper(IRealmMapper realmMapper)
void	setReturnToUrlParameters(Set<String> returnToUrlParameters) Specifies any extra parameters submitted along with the identity field which should be appended to the return_to URL which is assembled by buildReturnToUrl(javax.servlet.http.HttpServletRequest).

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

DEFAULT_CLAIMED_IDENTITY_FIELD

public static final String DEFAULT_CLAIMED_IDENTITY_FIELD

See Also:

Constant Field Values

Constructor Detail

OpenIdAuthenticationService

public OpenIdAuthenticationService()

OpenIdAuthenticationService

public OpenIdAuthenticationService(OpenIdConnectionFactory connectionFactory)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Overrides:

afterPropertiesSet in class org.springframework.social.security.provider.AbstractSocialAuthenticationService<OpenId>

Throws:

Exception

setConnectionFactory

public void setConnectionFactory(OpenIdConnectionFactory connectionFactory)

getConnectionFactory

public OpenIdConnectionFactory getConnectionFactory()

getAuthToken

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

Throws:

org.springframework.social.security.SocialAuthenticationRedirectException

obtainAccountData

protected Map<String,String> obtainAccountData(org.springframework.security.openid.OpenIDAuthenticationToken token)

lookupRealm

protected String lookupRealm(String returnToUrl)

buildReturnToUrl

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

Builds the return_to URL that will be sent to the OpenID service provider. By default returns the URL of the current request.

Parameters:

request - the current request which is being processed by this filter

Returns:

The return_to URL.

obtainUsername

protected String obtainUsername(javax.servlet.http.HttpServletRequest req)

Reads the claimedIdentityFieldName from the submitted request.

setClaimedIdentityFieldName

public void setClaimedIdentityFieldName(String claimedIdentityFieldName)

The name of the request parameter containing the OpenID identity, as submitted from the initial login form.

Parameters:

claimedIdentityFieldName - defaults to "openid_identifier"

setConsumer

public void setConsumer(org.springframework.security.openid.OpenIDConsumer consumer)

getRealmMapper

public IRealmMapper getRealmMapper()

setRealmMapper

public void setRealmMapper(IRealmMapper realmMapper)

setReturnToUrlParameters

public void setReturnToUrlParameters(Set<String> returnToUrlParameters)

Specifies any extra parameters submitted along with the identity field which should be appended to the return_to URL which is assembled by buildReturnToUrl(javax.servlet.http.HttpServletRequest).

Parameters:

returnToUrlParameters - the set of parameter names. If not set, it will default to the parameter name used by the RememberMeServices obtained from the parent class (if one is set).