org.pac4j.core.client

Class IndirectClient<C extends Credentials,U extends CommonProfile>

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

All Implemented Interfaces:

Client<C,U>

Direct Known Subclasses:

BaseOAuthClient, BaseOpenIdClient, GaeUserServiceClient, IndirectClientV2, SAML2Client

public abstract class IndirectClient<C extends Credentials,U extends CommonProfile>
extends BaseClient<C,U>

This class is the default indirect (with redirection, stateful) implementation of an authentication client (whatever the mechanism).

The callback url is managed via the setCallbackUrl(String) and getCallbackUrl() methods. The way the callback url is finally computed is done by the callbackUrlResolver which returns by default the provided callbackUrl.

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTEMPTED_AUTHENTICATION_SUFFIX
protected String	callbackUrl
protected CallbackUrlResolver	callbackUrlResolver

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

logger

Constructor Summary

Constructors

Constructor and Description
IndirectClient()

Method Summary

Modifier and Type	Method and Description
String	computeFinalCallbackUrl(WebContext context)
AjaxRequestResolver	getAjaxRequestResolver()
String	getCallbackUrl()
CallbackUrlResolver	getCallbackUrlResolver()
C	getCredentials(WebContext context) Get the credentials from the web context.
RedirectAction	getRedirectAction(WebContext context) Get the redirectAction computed for this client.
protected String	getStateParameter(WebContext webContext) Return the state parameter required by some security protocols like SAML or OAuth.
protected void	internalInit(WebContext context) Internal initialization of the object.
boolean	isIncludeClientNameInCallbackUrl()
HttpAction	redirect(WebContext context) Redirect to the authentication provider for an indirect client.
protected abstract RedirectAction	retrieveRedirectAction(WebContext context) Retrieve the redirect action.
void	setAjaxRequestResolver(AjaxRequestResolver ajaxRequestResolver)
void	setCallbackUrl(String callbackUrl)
void	setCallbackUrlResolver(CallbackUrlResolver callbackUrlResolver)
void	setIncludeClientNameInCallbackUrl(boolean includeClientNameInCallbackUrl)
String	toString()

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

addAuthorizationGenerator, addAuthorizationGenerators, getAuthorizationGenerators, getName, getUserProfile, retrieveCredentials, retrieveUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName

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

ATTEMPTED_AUTHENTICATION_SUFFIX

public static final String ATTEMPTED_AUTHENTICATION_SUFFIX

See Also:

Constant Field Values

callbackUrl

protected String callbackUrl

callbackUrlResolver

protected CallbackUrlResolver callbackUrlResolver

Constructor Detail

IndirectClient

public IndirectClient()

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Specified by:

internalInit in class InitializableWebObject

Parameters:

context - the web context

redirect

public final HttpAction redirect(WebContext context)
                          throws HttpAction

Description copied from interface: Client

Redirect to the authentication provider for an indirect client.

Parameters:

context - the current web context

Returns:

the performed redirection

Throws:

HttpAction - whether an additional HTTP action is required

getRedirectAction

public final RedirectAction getRedirectAction(WebContext context)
                                       throws HttpAction

Get the redirectAction computed for this client. All the logic is encapsulated here. It should not be called be directly, the redirect(WebContext) should be generally called instead.

If an authentication has already been tried for this client and has failed (null credentials) or if the request is an AJAX one, an authorized response (401 HTTP status code) is returned instead of a redirection.

Parameters:

context - context

Returns:

the redirection action

Throws:

HttpAction - requires an additional HTTP action

retrieveRedirectAction

protected abstract RedirectAction retrieveRedirectAction(WebContext context)
                                                  throws HttpAction

Retrieve the redirect action.

Parameters:

context - the web context

Returns:

the redirection action

Throws:

HttpAction - requires a specific HTTP action if necessary

getCredentials

public final C getCredentials(WebContext context)
                       throws HttpAction

Get the credentials from the web context. In some cases, a HttpAction may be thrown:

• if the CasClient receives a logout request, it returns a 200 HTTP status code
• for the IndirectBasicAuthClient, if no credentials are sent to the callback url, an unauthorized response (401 HTTP status code) is returned to request credentials through a popup.

Parameters:

context - the current web context

Returns:

the credentials

Throws:

HttpAction - whether an additional HTTP action is required

computeFinalCallbackUrl

public String computeFinalCallbackUrl(WebContext context)

getStateParameter

protected String getStateParameter(WebContext webContext)

Return the state parameter required by some security protocols like SAML or OAuth.

Parameters:

webContext - web context

Returns:

the state

isIncludeClientNameInCallbackUrl

public boolean isIncludeClientNameInCallbackUrl()

setIncludeClientNameInCallbackUrl

public void setIncludeClientNameInCallbackUrl(boolean includeClientNameInCallbackUrl)

setCallbackUrl

public void setCallbackUrl(String callbackUrl)

getCallbackUrl

public String getCallbackUrl()

getAjaxRequestResolver

public AjaxRequestResolver getAjaxRequestResolver()

setAjaxRequestResolver

public void setAjaxRequestResolver(AjaxRequestResolver ajaxRequestResolver)

getCallbackUrlResolver

public CallbackUrlResolver getCallbackUrlResolver()

setCallbackUrlResolver

public void setCallbackUrlResolver(CallbackUrlResolver callbackUrlResolver)

toString

public String toString()

Overrides:

toString in class BaseClient<C extends Credentials,U extends CommonProfile>