org.pac4j.http.client.direct

Class DirectHttpClient<C extends Credentials>

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

org.pac4j.core.client.DirectClient<C,CommonProfile>

org.pac4j.http.client.direct.DirectHttpClient<C>

All Implemented Interfaces:

Cloneable, Client<C,CommonProfile>

Direct Known Subclasses:

AbstractCasRestClient, AnonymousClient, CookieClient, DirectBasicAuthClient, DirectFormClient, HeaderClient, IpClient, ParameterClient

public abstract class DirectHttpClient<C extends Credentials>
extends DirectClient<C,CommonProfile>

This class is the base HTTP client to authenticate directly users through HTTP protocol.

All the logic is based on Extractor, Authenticator and ProfileCreator.

It returns a HttpProfile.

Since:

1.8.0

Author:

Jerome Leleu

See Also:

HttpProfile

Field Summary

Fields

Modifier and Type	Field and Description
protected Extractor<C>	extractor

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

logger

Constructor Summary

Constructors

Constructor and Description
DirectHttpClient()

Method Summary

Modifier and Type	Method and Description
DirectHttpClient<C>	clone() Clone the current client.
Authenticator<C>	getAuthenticator()
C	getCredentials(WebContext context) Get the credentials from the web context.
ProfileCreator<C,CommonProfile>	getProfileCreator()
protected void	internalInit(WebContext context) Internal initialization of the object.
protected CommonProfile	retrieveUserProfile(C credentials, WebContext context)
void	setAuthenticator(Authenticator<C> authenticator)
void	setProfileCreator(ProfileCreator<C,CommonProfile> profileCreator)
String	toString()

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

redirect

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

addAuthorizationGenerator, getAuthorizationGenerators, getClientType, getName, getUserProfile, newClient, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName

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

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

extractor

protected Extractor<C extends Credentials> extractor

Constructor Detail

DirectHttpClient

public DirectHttpClient()

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

clone

public DirectHttpClient<C> clone()

Description copied from class: BaseClient

Clone the current client.

Overrides:

clone in class BaseClient<C extends Credentials,CommonProfile>

Returns:

the cloned client

getCredentials

public C getCredentials(WebContext context)
                 throws RequiresHttpAction

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 RequiresHttpAction may be thrown instead.

Parameters:

context - the current web context

Returns:

the credentials

Throws:

RequiresHttpAction - whether an additional HTTP action is required

retrieveUserProfile

protected CommonProfile retrieveUserProfile(C credentials,
                                            WebContext context)

Specified by:

retrieveUserProfile in class BaseClient<C extends Credentials,CommonProfile>

toString

public String toString()

Overrides:

toString in class BaseClient<C extends Credentials,CommonProfile>

getAuthenticator

public Authenticator<C> getAuthenticator()

setAuthenticator

public void setAuthenticator(Authenticator<C> authenticator)

getProfileCreator

public ProfileCreator<C,CommonProfile> getProfileCreator()

setProfileCreator

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