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>

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

Indirect client: the requested protected URL is saved, the user is redirected to the identity provider for login and back to the application after the sucessful authentication and finally to the originally requested URL.

Since:

1.9.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTEMPTED_AUTHENTICATION_SUFFIX
protected java.lang.String	callbackUrl
protected UrlResolver	urlResolver

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
protected abstract void	clientInit(WebContext context) Initialize the client.
java.lang.String	computeFinalCallbackUrl(WebContext context)
protected void	defaultLogoutActionBuilder(LogoutActionBuilder<U> logoutActionBuilder)
protected void	defaultRedirectActionBuilder(RedirectActionBuilder redirectActionBuilder)
AjaxRequestResolver	getAjaxRequestResolver()
java.lang.String	getCallbackUrl()
UrlResolver	getCallbackUrlResolver() Deprecated.
C	getCredentials(WebContext context) Get the credentials from the web context.
RedirectAction	getLogoutAction(WebContext context, U currentProfile, java.lang.String targetUrl) Return the logout action (indirect clients).
LogoutActionBuilder<U>	getLogoutActionBuilder()
RedirectAction	getRedirectAction(WebContext context) Get the redirectAction computed for this client.
RedirectActionBuilder	getRedirectActionBuilder()
UrlResolver	getUrlResolver()
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.
void	setAjaxRequestResolver(AjaxRequestResolver ajaxRequestResolver)
void	setCallbackUrl(java.lang.String callbackUrl)
void	setCallbackUrlResolver(UrlResolver callbackUrlResolver) Deprecated.
void	setIncludeClientNameInCallbackUrl(boolean includeClientNameInCallbackUrl)
void	setLogoutActionBuilder(LogoutActionBuilder<U> logoutActionBuilder)
void	setRedirectActionBuilder(RedirectActionBuilder redirectActionBuilder)
void	setUrlResolver(UrlResolver urlResolver)
java.lang.String	toString()

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getName, getProfileCreator, getUserProfile, notifySessionRenewal, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setName, setProfileCreator

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 java.lang.String ATTEMPTED_AUTHENTICATION_SUFFIX

See Also:

Constant Field Values

callbackUrl

protected java.lang.String callbackUrl

urlResolver

protected UrlResolver urlResolver

Constructor Detail

IndirectClient

public IndirectClient()

Method Detail

internalInit

protected final 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

clientInit

protected abstract void clientInit(WebContext context)

Initialize the client.

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

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

getLogoutAction

public final RedirectAction getLogoutAction(WebContext context,
                                            U currentProfile,
                                            java.lang.String targetUrl)

Description copied from interface: Client

Return the logout action (indirect clients).

Parameters:

context - the current web context

currentProfile - the currentProfile

targetUrl - the target url after logout

Returns:

the redirection

computeFinalCallbackUrl

public java.lang.String computeFinalCallbackUrl(WebContext context)

isIncludeClientNameInCallbackUrl

public boolean isIncludeClientNameInCallbackUrl()

setIncludeClientNameInCallbackUrl

public void setIncludeClientNameInCallbackUrl(boolean includeClientNameInCallbackUrl)

setCallbackUrl

public void setCallbackUrl(java.lang.String callbackUrl)

getCallbackUrl

public java.lang.String getCallbackUrl()

getCallbackUrlResolver

@Deprecated
public UrlResolver getCallbackUrlResolver()

Deprecated.

Use getUrlResolver() instead.

Returns:

the URL resolver for the callback URL

setCallbackUrlResolver

@Deprecated
public void setCallbackUrlResolver(UrlResolver callbackUrlResolver)

Deprecated.

Use setUrlResolver(UrlResolver) instead.

Parameters:

callbackUrlResolver - the URL resolver for the callback URL

getUrlResolver

public UrlResolver getUrlResolver()

setUrlResolver

public void setUrlResolver(UrlResolver urlResolver)

getAjaxRequestResolver

public AjaxRequestResolver getAjaxRequestResolver()

setAjaxRequestResolver

public void setAjaxRequestResolver(AjaxRequestResolver ajaxRequestResolver)

getRedirectActionBuilder

public RedirectActionBuilder getRedirectActionBuilder()

defaultRedirectActionBuilder

protected void defaultRedirectActionBuilder(RedirectActionBuilder redirectActionBuilder)

getLogoutActionBuilder

public LogoutActionBuilder<U> getLogoutActionBuilder()

defaultLogoutActionBuilder

protected void defaultLogoutActionBuilder(LogoutActionBuilder<U> logoutActionBuilder)

setRedirectActionBuilder

public void setRedirectActionBuilder(RedirectActionBuilder redirectActionBuilder)

setLogoutActionBuilder

public void setLogoutActionBuilder(LogoutActionBuilder<U> logoutActionBuilder)

toString

public java.lang.String toString()

Overrides:

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