Package org.pac4j.core.client

Class DirectClient

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient

org.pac4j.core.client.DirectClient

All Implemented Interfaces:

Client

Direct Known Subclasses:

AnonymousClient

public abstract class DirectClient
extends BaseClient

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

Constructor Summary

Constructors

Constructor	Description
DirectClient()

Method Summary

Modifier and Type	Method	Description
protected final void	afterInternalInit(boolean forceReinit)	afterInternalInit.
protected void	beforeInternalInit(boolean forceReinit)	beforeInternalInit.
final Optional<RedirectionAction>	getLogoutAction(CallContext ctx, UserProfile currentProfile, String targetUrl)	Return the logout action (indirect clients).
final Optional<RedirectionAction>	getRedirectionAction(CallContext ctx)	Return the redirection action to the authentication provider (indirect clients).
final HttpAction	processLogout(CallContext ctx, Credentials credentials)	Process the logout.

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

addAuthorizationGenerator, addAuthorizationGenerators, checkCredentials, getCredentials, getName, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, notifySessionRenewal, renewUserProfile, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractorIfUndefined, setCustomProperties, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, validateCredentials

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

getNbAttempts, init, init, internalInit, isInitialized, reinit, shouldInitialize

Methods inherited from class java.lang.Object

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

Constructor Details

DirectClient

public DirectClient()

Method Details

beforeInternalInit

protected void beforeInternalInit(boolean forceReinit)

beforeInternalInit.

Overrides:

beforeInternalInit in class InitializableObject

Parameters:

forceReinit - a boolean

afterInternalInit

protected final void afterInternalInit(boolean forceReinit)

afterInternalInit.

Overrides:

afterInternalInit in class InitializableObject

Parameters:

forceReinit - a boolean

getRedirectionAction

public final Optional<RedirectionAction> getRedirectionAction(CallContext ctx)

Return the redirection action to the authentication provider (indirect clients).

Parameters:

ctx - the current context

Returns:

the redirection to perform (optional)

processLogout

public final HttpAction processLogout(CallContext ctx,
 Credentials credentials)

Process the logout.

Parameters:

ctx - the current context

credentials - the logout credentials

Returns:

the resulting HTTP action

getLogoutAction

public final Optional<RedirectionAction> getLogoutAction(CallContext ctx,
 UserProfile currentProfile,
 String targetUrl)

Return the logout action (indirect clients).

Parameters:

ctx - the current context

currentProfile - the currentProfile

targetUrl - the target url after logout

Returns:

the redirection to perform (optional)