org.pac4j.core.client

Class DirectClient<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.DirectClient<C,U>

All Implemented Interfaces:

Client<C,U>

Direct Known Subclasses:

AnonymousClient

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

Direct client: credentials are passed and authentication occurs for every HTTP request.

Since:

1.9.0

Author:

Jerome Leleu

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
DirectClient()

Method Summary

Modifier and Type	Method and Description
protected abstract void	clientInit(WebContext context) Initialize the client.
C	getCredentials(WebContext context) Get the credentials from the web context.
RedirectAction	getLogoutAction(WebContext context, U currentProfile, String targetUrl) Return the logout action (indirect clients).
protected void	internalInit(WebContext context) Internal initialization of the object.
HttpAction	redirect(WebContext context) Redirect to the authentication provider for an indirect client.

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

Constructor Detail

DirectClient

public DirectClient()

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

getCredentials

public final C getCredentials(WebContext context)
                       throws HttpAction

Description copied from interface: Client

Get the credentials from the web context. If no validation was made remotely (direct client), credentials must be validated at this step.

In some cases, a HttpAction may be thrown instead.

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