org.pac4j.core.client

Class BaseClient<C extends Credentials,U extends CommonProfile>

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

All Implemented Interfaces:

Client<C,U>

Direct Known Subclasses:

DirectClient, IndirectClient

public abstract class BaseClient<C extends Credentials,U extends CommonProfile>
extends InitializableWebObject
implements Client<C,U>

This class is the default implementation of an authentication client (whatever the mechanism). It has the core concepts:

• The initialization process is handled by the InitializableWebObject inheritance, the InitializableWebObject.internalInit(WebContext) must be implemented in sub-classes. The InitializableWebObject.init(WebContext) method must be called implicitly by the main methods of the Client interface, so that no explicit call is required to initialize the client
• The name of the client is handled through the setName(String) and getName() methods
• After retrieving the user profile, the client can generate the authorization information (roles, permissions and remember-me) by using the appropriate AuthorizationGenerator.

Since:

1.4.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
BaseClient()

Method Summary

Modifier and Type	Method and Description
void	addAuthorizationGenerator(AuthorizationGenerator<U> authorizationGenerator)
void	addAuthorizationGenerators(List<AuthorizationGenerator<U>> authorizationGenerators)
List<AuthorizationGenerator<U>>	getAuthorizationGenerators()
String	getName() Get the name of the client.
U	getUserProfile(C credentials, WebContext context) Get the user profile based on the provided credentials.
protected abstract C	retrieveCredentials(WebContext context) Retrieve the credentials.
protected abstract U	retrieveUserProfile(C credentials, WebContext context) Retrieve a user userprofile.
void	setAuthorizationGenerator(AuthorizationGenerator<U> authorizationGenerator) Add an authorization generator.
void	setAuthorizationGenerators(AuthorizationGenerator<U>... authorizationGenerators)
void	setAuthorizationGenerators(List<AuthorizationGenerator<U>> authorizationGenerators)
void	setName(String name)
String	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

Methods inherited from interface org.pac4j.core.client.Client

getCredentials, redirect

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

BaseClient

public BaseClient()

Method Detail

retrieveCredentials

protected abstract C retrieveCredentials(WebContext context)
                                  throws HttpAction

Retrieve the credentials.

Parameters:

context - the web context

Returns:

the credentials

Throws:

HttpAction - whether an additional HTTP action is required

getUserProfile

public final U getUserProfile(C credentials,
                              WebContext context)
                       throws HttpAction

Description copied from interface: Client

Get the user profile based on the provided credentials.

Specified by:

getUserProfile in interface Client<C extends Credentials,U extends CommonProfile>

Parameters:

credentials - credentials

context - web context

Returns:

the user profile

Throws:

HttpAction - whether an additional HTTP action is required

retrieveUserProfile

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

Retrieve a user userprofile.

Parameters:

credentials - the credentials

context - the web context

Returns:

the user profile

Throws:

HttpAction - whether an additional HTTP action is required

setName

public void setName(String name)

getName

public String getName()

Description copied from interface: Client

Get the name of the client.

Specified by:

getName in interface Client<C extends Credentials,U extends CommonProfile>

Returns:

the name of the client

getAuthorizationGenerators

public List<AuthorizationGenerator<U>> getAuthorizationGenerators()

setAuthorizationGenerators

public void setAuthorizationGenerators(List<AuthorizationGenerator<U>> authorizationGenerators)

setAuthorizationGenerators

public void setAuthorizationGenerators(AuthorizationGenerator<U>... authorizationGenerators)

setAuthorizationGenerator

public void setAuthorizationGenerator(AuthorizationGenerator<U> authorizationGenerator)

Add an authorization generator.

Parameters:

authorizationGenerator - an authorizations generator

addAuthorizationGenerator

public void addAuthorizationGenerator(AuthorizationGenerator<U> authorizationGenerator)

addAuthorizationGenerators

public void addAuthorizationGenerators(List<AuthorizationGenerator<U>> authorizationGenerators)

toString

public String toString()

Overrides:

toString in class Object