org.pac4j.openid.client

Class BaseOpenIdClient<U extends CommonProfile>

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.client.BaseClient<C,U>

org.pac4j.core.client.IndirectClient<OpenIdCredentials,U>

org.pac4j.openid.client.BaseOpenIdClient<U>

All Implemented Interfaces:

Client<OpenIdCredentials,U>

Direct Known Subclasses:

YahooOpenIdClient

public abstract class BaseOpenIdClient<U extends CommonProfile>
extends IndirectClient<OpenIdCredentials,U>

This class is a base implementation for an OpenID protocol client based on the openid4java library. It should work for all OpenID clients. In subclasses, some methods are to be implemented / customized for specific needs depending on the client.

Since:

1.4.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISCOVERY_INFORMATION

Fields inherited from class org.pac4j.core.client.IndirectClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver

Fields inherited from class org.pac4j.core.client.BaseClient

logger

Constructor Summary

Constructors

Constructor and Description
BaseOpenIdClient()

Method Summary

Modifier and Type	Method and Description
protected abstract U	createProfile(org.openid4java.message.AuthSuccess authSuccess) Create the appropriate OpenID profile.
protected String	getDiscoveryInformationSessionAttributeName() Return the name of the attribute storing in session the discovery information.
protected abstract org.openid4java.message.ax.FetchRequest	getFetchRequest() Get a fetch request for attributes.
protected abstract String	getUser(WebContext context) Return the user identifier for the web context.
protected void	internalInit(WebContext context) Internal initialization of the object.
protected OpenIdCredentials	retrieveCredentials(WebContext context) Retrieve the credentials.
protected RedirectAction	retrieveRedirectAction(WebContext context) Retrieve the redirect action.
protected U	retrieveUserProfile(OpenIdCredentials credentials, WebContext context) Retrieve a user userprofile.

Methods inherited from class org.pac4j.core.client.IndirectClient

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName, toString

Methods inherited from class org.pac4j.core.util.InitializableWebObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

DISCOVERY_INFORMATION

public static final String DISCOVERY_INFORMATION

See Also:

Constant Field Values

Constructor Detail

BaseOpenIdClient

public BaseOpenIdClient()

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class IndirectClient<OpenIdCredentials,U extends CommonProfile>

Parameters:

context - the web context

getUser

protected abstract String getUser(WebContext context)

Return the user identifier for the web context.

Parameters:

context - the web context

Returns:

the user identifier

getDiscoveryInformationSessionAttributeName

protected String getDiscoveryInformationSessionAttributeName()

Return the name of the attribute storing in session the discovery information.

Returns:

the name of the attribute storing in session the discovery information

getFetchRequest

protected abstract org.openid4java.message.ax.FetchRequest getFetchRequest()
                                                                    throws org.openid4java.message.MessageException

Get a fetch request for attributes.

Returns:

a fetch request for attributes

Throws:

org.openid4java.message.MessageException - an OpenID exception

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)
                                         throws HttpAction

Description copied from class: IndirectClient

Retrieve the redirect action.

Specified by:

retrieveRedirectAction in class IndirectClient<OpenIdCredentials,U extends CommonProfile>

Parameters:

context - the web context

Returns:

the redirection action

Throws:

HttpAction - requires a specific HTTP action if necessary

retrieveCredentials

protected OpenIdCredentials retrieveCredentials(WebContext context)
                                         throws HttpAction

Description copied from class: IndirectClient

Retrieve the credentials.

Specified by:

retrieveCredentials in class IndirectClient<OpenIdCredentials,U extends CommonProfile>

Parameters:

context - the web context

Returns:

the credentials

Throws:

HttpAction - whether an additional HTTP action is required

createProfile

protected abstract U createProfile(org.openid4java.message.AuthSuccess authSuccess)
                            throws HttpAction,
                                   org.openid4java.message.MessageException

Create the appropriate OpenID profile.

Parameters:

authSuccess - the authentication success message

Returns:

the appropriate OpenID profile

Throws:

org.openid4java.message.MessageException - an OpenID exception

HttpAction - whether an additional HTTP action is required

retrieveUserProfile

protected U retrieveUserProfile(OpenIdCredentials credentials,
                                WebContext context)
                         throws HttpAction

Description copied from class: BaseClient

Retrieve a user userprofile.

Specified by:

retrieveUserProfile in class BaseClient<OpenIdCredentials,U extends CommonProfile>

Parameters:

credentials - the credentials

context - the web context

Returns:

the user profile

Throws:

HttpAction - whether an additional HTTP action is required