org.pac4j.openid.client

Class BaseOpenIdClient<U extends CommonProfile>

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

All Implemented Interfaces:

Cloneable, Client<OpenIdCredentials,U>

Direct Known Subclasses:

GoogleOpenIdClient

public abstract class BaseOpenIdClient<U extends CommonProfile>
extends BaseClient<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.BaseClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, logger, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
BaseOpenIdClient()

Method Summary

Methods

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.
Protocol	getProtocol()
protected abstract String	getUser(WebContext context) Return the user identifier for the web context.
protected void	internalInit()
protected boolean	isDirectRedirection()
protected OpenIdCredentials	retrieveCredentials(WebContext context)
protected RedirectAction	retrieveRedirectAction(WebContext context)
protected U	retrieveUserProfile(OpenIdCredentials credentials, WebContext context)

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

addAuthorizationGenerator, clone, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getRedirectAction, getRedirectionUrl, getUserProfile, isEnableContextualRedirects, newClient, prependHostToUrlIfNotPresent, redirect, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setName, toString

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

init, reinit

Methods inherited from class java.lang.Object

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()

Specified by:

internalInit in class InitializableObject

getUser

protected abstract String getUser(WebContext context)

Return the user identifier for the web context.

Parameters:

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

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)

Specified by:

retrieveRedirectAction in class BaseClient<OpenIdCredentials,U extends CommonProfile>

isDirectRedirection

protected boolean isDirectRedirection()

Specified by:

isDirectRedirection in class BaseClient<OpenIdCredentials,U extends CommonProfile>

retrieveCredentials

protected OpenIdCredentials retrieveCredentials(WebContext context)

Specified by:

retrieveCredentials in class BaseClient<OpenIdCredentials,U extends CommonProfile>

createProfile

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

Create the appropriate OpenID profile.

Parameters:

authSuccess -

Returns:

the appropriate OpenID profile

Throws:

org.openid4java.message.MessageException

retrieveUserProfile

protected U retrieveUserProfile(OpenIdCredentials credentials,
                    WebContext context)

Specified by:

retrieveUserProfile in class BaseClient<OpenIdCredentials,U extends CommonProfile>

getProtocol

public Protocol getProtocol()

Specified by:

getProtocol in class BaseClient<OpenIdCredentials,U extends CommonProfile>