org.pac4j.core.client.direct

Class AnonymousClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

org.pac4j.core.client.DirectClient<AnonymousCredentials,AnonymousProfile>

org.pac4j.core.client.direct.AnonymousClient

All Implemented Interfaces:

Client<AnonymousCredentials,AnonymousProfile>

public final class AnonymousClient
extends DirectClient<AnonymousCredentials,AnonymousProfile>

Anonymous client. Not to be used except for advanced use cases.

Since:

1.8.1

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static AnonymousClient	INSTANCE

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

logger

Constructor Summary

Constructors

Constructor and Description
AnonymousClient()

Method Summary

Modifier and Type	Method and Description
AnonymousCredentials	getCredentials(WebContext context) Get the credentials from the web context.
protected void	internalInit(WebContext context) Internal initialization of the object.
protected AnonymousProfile	retrieveUserProfile(AnonymousCredentials credentials, WebContext context) Retrieve a user userprofile.

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

redirect

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

addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName, 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

Field Detail

INSTANCE

public static final AnonymousClient INSTANCE

Constructor Detail

AnonymousClient

public AnonymousClient()

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

getCredentials

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

retrieveUserProfile

protected AnonymousProfile retrieveUserProfile(AnonymousCredentials credentials,
                                               WebContext context)
                                        throws HttpAction

Description copied from class: BaseClient

Retrieve a user userprofile.

Specified by:

retrieveUserProfile in class BaseClient<AnonymousCredentials,AnonymousProfile>

Parameters:

credentials - the credentials

context - the web context

Returns:

the user profile

Throws:

HttpAction - whether an additional HTTP action is required