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

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

This class is the default direct (stateless) implementation of an authentication client (whatever the mechanism). In that case, redirecting does not make any sense.

Since:

1.8.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
C	getCredentials(WebContext context) Get the credentials from the web context.
HttpAction	redirect(WebContext context) Redirect to the authentication provider for an indirect client.

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

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

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

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

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