org.jboss.seam.security.external.openid
Class OpenIdProviderBean

java.lang.Object
  org.jboss.seam.security.external.EntityBean
      org.jboss.seam.security.external.openid.OpenIdProviderBean

All Implemented Interfaces:

EntityConfigurationApi, OpenIdProviderApi, OpenIdProviderConfigurationApi

@Typed(value=OpenIdProviderBean.class)
public class OpenIdProviderBean
extends EntityBean
implements OpenIdProviderApi, OpenIdProviderConfigurationApi

Author:

Marcel Kolsteren

Field Summary

Fields inherited from class org.jboss.seam.security.external.EntityBean

hostName, port, protocol

Constructor Summary

OpenIdProviderBean()

Method Summary

void	authenticationFailed(HttpServletResponse response) This is one of the possible reactions of the application after having received and processed an authentication request through the API call OpenIdProviderSpi.authenticate(String, String, boolean, ResponseHolder) .
void	authenticationSucceeded(String userName, HttpServletResponse response) This is one of the possible reactions of the application after having received and processed an authentication request through the API call OpenIdProviderSpi.authenticate(String, String, boolean, ResponseHolder) .
String	getOpLocalIdentifierForUserName(String userName) This method can be used to find out the OP-Local identifier for a given user name.
String	getRealm()
String	getServiceURL(OpenIdService service)
String	getUserNameFromOpLocalIdentifier(String opLocalIdentifier)
String	getUsersPath()
String	getUsersUrlPrefix()
String	getXrdsURL() Gets the URL where the XRDS is served that can be used by relying parties for OpenID Provider discovery.
void	setAttributes(Map<String,List<String>> attributeValues, HttpServletResponse response)
void	writeClaimedIdentifierXrds(Writer writer, String opLocalIdentifier)
void	writeOpIdentifierXrds(Writer writer) Write XRDS with OP identifier (see OpenId 2.0 Authentication spec, section 7.3.2.1.1.)

Methods inherited from class org.jboss.seam.security.external.EntityBean

createURL, getHostName, getPort, getProtocol, setHostName, setPort, setProtocol

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.seam.security.external.api.EntityConfigurationApi

getHostName, getPort, getProtocol, setHostName, setPort, setProtocol

Constructor Detail

OpenIdProviderBean

public OpenIdProviderBean()

Method Detail

getServiceURL

public String getServiceURL(OpenIdService service)

getRealm

public String getRealm()

getXrdsURL

public String getXrdsURL()

Description copied from interface: OpenIdProviderConfigurationApi

Gets the URL where the XRDS is served that can be used by relying parties for OpenID Provider discovery. The document served at this URL is described in the OpenID 2.0 Authentication specification, section 7.3.2.1.1.

Specified by:

getXrdsURL in interface OpenIdProviderConfigurationApi

Returns:

the URL

writeOpIdentifierXrds

public void writeOpIdentifierXrds(Writer writer)

Write XRDS with OP identifier (see OpenId 2.0 Authentication spec, section 7.3.2.1.1.)

Parameters:

writer - writer to use

writeClaimedIdentifierXrds

public void writeClaimedIdentifierXrds(Writer writer,
                                       String opLocalIdentifier)

getOpLocalIdentifierForUserName

public String getOpLocalIdentifierForUserName(String userName)

Description copied from interface: OpenIdProviderApi

This method can be used to find out the OP-Local identifier for a given user name. The OpenID authentication specification defines this identifier as follows: 'An alternate Identifier for an end user that is local to a particular OP and thus not necessarily under the end user's control'.

Specified by:

getOpLocalIdentifierForUserName in interface OpenIdProviderApi

Parameters:

userName - user name

Returns:

the OP-Local Identifier

getUserNameFromOpLocalIdentifier

public String getUserNameFromOpLocalIdentifier(String opLocalIdentifier)

getUsersPath

public String getUsersPath()

getUsersUrlPrefix

public String getUsersUrlPrefix()

authenticationFailed

public void authenticationFailed(HttpServletResponse response)

Description copied from interface: OpenIdProviderApi

This is one of the possible reactions of the application after having received and processed an authentication request through the API call OpenIdProviderSpi.authenticate(String, String, boolean, ResponseHolder) . By calling this method, the application informs the OpenID provider module that authentication failed. The OpenID provider module will redirect the user back to the relying party's website.

Specified by:

authenticationFailed in interface OpenIdProviderApi

Parameters:

response - HTTP response

authenticationSucceeded

public void authenticationSucceeded(String userName,
                                    HttpServletResponse response)

Description copied from interface: OpenIdProviderApi

This is one of the possible reactions of the application after having received and processed an authentication request through the API call OpenIdProviderSpi.authenticate(String, String, boolean, ResponseHolder) . By calling this method, the application informs the OpenID provider module that authentication succeeded. The userName of the authenticated user is provided. The OpenID provider module will redirect the user back to the relying party's website.

Specified by:

authenticationSucceeded in interface OpenIdProviderApi

Parameters:

userName - user name

response - HTTP response

setAttributes

public void setAttributes(Map<String,List<String>> attributeValues,
                          HttpServletResponse response)

Specified by:

setAttributes in interface OpenIdProviderApi