org.pac4j.http.client

Class BaseHttpClient

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<UsernamePasswordCredentials,HttpProfile>

org.pac4j.http.client.BaseHttpClient

All Implemented Interfaces:

Cloneable, Client<UsernamePasswordCredentials,HttpProfile>

Direct Known Subclasses:

BasicAuthClient, FormClient

public abstract class BaseHttpClient
extends BaseClient<UsernamePasswordCredentials,HttpProfile>

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

The username and password inputs must be retrieved through HTTP protocol.

To validate credentials, an UsernamePasswordAuthenticator must be defined through the setUsernamePasswordAuthenticator(UsernamePasswordAuthenticator) method.

To create the profile, a ProfileCreator must be defined through the setProfileCreator(ProfileCreator) method.

It returns a HttpProfile.

Since:

1.4.0

Author:

Jerome Leleu

See Also:

HttpProfile

Field Summary

Fields

Modifier and Type	Field and Description
protected UsernamePasswordAuthenticator	usernamePasswordAuthenticator

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

callbackUrl, logger, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
BaseHttpClient()

Method Summary

Methods

Modifier and Type	Method and Description
BaseHttpClient	clone()
ProfileCreator	getProfileCreator()
Protocol	getProtocol()
UsernamePasswordAuthenticator	getUsernamePasswordAuthenticator()
protected void	internalInit()
protected HttpProfile	retrieveUserProfile(UsernamePasswordCredentials credentials)
void	setProfileCreator(ProfileCreator profileCreator)
void	setUsernamePasswordAuthenticator(UsernamePasswordAuthenticator usernamePasswordAuthenticator)

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

getCallbackUrl, getCredentials, getName, getRedirectionUrl, getRedirectionUrl, getUserProfile, isDirectRedirection, newClient, retrieveCredentials, retrieveRedirectionUrl, setCallbackUrl, setName, toString

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

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

usernamePasswordAuthenticator

protected UsernamePasswordAuthenticator usernamePasswordAuthenticator

Constructor Detail

BaseHttpClient

public BaseHttpClient()

Method Detail

clone

public BaseHttpClient clone()

Overrides:

clone in class BaseClient<UsernamePasswordCredentials,HttpProfile>

internalInit

protected void internalInit()

Specified by:

internalInit in class InitializableObject

retrieveUserProfile

protected HttpProfile retrieveUserProfile(UsernamePasswordCredentials credentials)

Specified by:

retrieveUserProfile in class BaseClient<UsernamePasswordCredentials,HttpProfile>

getUsernamePasswordAuthenticator

public UsernamePasswordAuthenticator getUsernamePasswordAuthenticator()

setUsernamePasswordAuthenticator

public void setUsernamePasswordAuthenticator(UsernamePasswordAuthenticator usernamePasswordAuthenticator)

getProfileCreator

public ProfileCreator getProfileCreator()

setProfileCreator

public void setProfileCreator(ProfileCreator profileCreator)

getProtocol

public Protocol getProtocol()

Specified by:

getProtocol in class BaseClient<UsernamePasswordCredentials,HttpProfile>