org.pac4j.http.client.direct

Class DirectFormClient

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

org.pac4j.http.client.direct.DirectFormClient

All Implemented Interfaces:

Cloneable, Client<UsernamePasswordCredentials,CommonProfile>

public class DirectFormClient
extends DirectHttpClient<UsernamePasswordCredentials>

This class is the client to authenticate users, based on form HTTP parameters.

It returns a HttpProfile.

Since:

1.8.6

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PASSWORD_PARAMETER
static String	DEFAULT_USERNAME_PARAMETER

Fields inherited from class org.pac4j.http.client.direct.DirectHttpClient

extractor

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

logger

Constructor Summary

Constructors

Constructor and Description
DirectFormClient()
DirectFormClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator)
DirectFormClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method and Description
ClientType	getClientType() Return the client type.
String	getPasswordParameter()
String	getUsernameParameter()
protected void	internalInit(WebContext context) Internal initialization of the object.
protected DirectHttpClient<UsernamePasswordCredentials>	newClient() Create a new instance of the client.
void	setPasswordParameter(String passwordParameter)
void	setUsernameParameter(String usernameParameter)
String	toString()

Methods inherited from class org.pac4j.http.client.direct.DirectHttpClient

clone, getAuthenticator, getCredentials, getProfileCreator, retrieveUserProfile, setAuthenticator, setProfileCreator

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

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

Field Detail

DEFAULT_USERNAME_PARAMETER

public static final String DEFAULT_USERNAME_PARAMETER

See Also:

Constant Field Values

DEFAULT_PASSWORD_PARAMETER

public static final String DEFAULT_PASSWORD_PARAMETER

See Also:

Constant Field Values

Constructor Detail

DirectFormClient

public DirectFormClient()

DirectFormClient

public DirectFormClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator)

DirectFormClient

public DirectFormClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator,
                        ProfileCreator profileCreator)

Method Detail

newClient

protected DirectHttpClient<UsernamePasswordCredentials> newClient()

Description copied from class: BaseClient

Create a new instance of the client.

Specified by:

newClient in class BaseClient<UsernamePasswordCredentials,CommonProfile>

Returns:

A new instance of the client

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class DirectHttpClient<UsernamePasswordCredentials>

Parameters:

context - the web context

getUsernameParameter

public String getUsernameParameter()

setUsernameParameter

public void setUsernameParameter(String usernameParameter)

getPasswordParameter

public String getPasswordParameter()

setPasswordParameter

public void setPasswordParameter(String passwordParameter)

toString

public String toString()

Overrides:

toString in class DirectHttpClient<UsernamePasswordCredentials>

getClientType

public ClientType getClientType()

Description copied from class: BaseClient

Return the client type.

Specified by:

getClientType in class BaseClient<UsernamePasswordCredentials,CommonProfile>

Returns:

the client type