org.pac4j.core.client

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

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

All Implemented Interfaces:

Client<C,U>

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

New direct client type using the CredentialsExtractor, Authenticator and ProfileCreator concepts.

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
DirectClientV2()

Method Summary

Modifier and Type	Method and Description
protected void	assertAuthenticatorTypes(Class<? extends Authenticator>... classes)
Authenticator<C>	getAuthenticator()
C	getCredentials(WebContext context) Get the credentials from the web context.
CredentialsExtractor<C>	getCredentialsExtractor()
ProfileCreator<C,U>	getProfileCreator()
protected void	internalInit(WebContext context) Internal initialization of the object.
protected U	retrieveUserProfile(C credentials, WebContext context) Retrieve a user userprofile.
void	setAuthenticator(Authenticator<C> authenticator)
void	setCredentialsExtractor(CredentialsExtractor<C> credentialsExtractor)
void	setProfileCreator(ProfileCreator<C,U> profileCreator)
String	toString()

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

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

DirectClientV2

public DirectClientV2()

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

retrieveUserProfile

protected U retrieveUserProfile(C credentials,
                                WebContext context)
                         throws HttpAction

Description copied from class: BaseClient

Retrieve a user userprofile.

Specified by:

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

Parameters:

credentials - the credentials

context - the web context

Returns:

the user profile

Throws:

HttpAction - whether an additional HTTP action is required

assertAuthenticatorTypes

protected void assertAuthenticatorTypes(Class<? extends Authenticator>... classes)

toString

public String toString()

Overrides:

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

getCredentialsExtractor

public CredentialsExtractor<C> getCredentialsExtractor()

setCredentialsExtractor

public void setCredentialsExtractor(CredentialsExtractor<C> credentialsExtractor)

getAuthenticator

public Authenticator<C> getAuthenticator()

setAuthenticator

public void setAuthenticator(Authenticator<C> authenticator)

getProfileCreator

public ProfileCreator<C,U> getProfileCreator()

setProfileCreator

public void setProfileCreator(ProfileCreator<C,U> profileCreator)