Package org.pac4j.http.client.direct

Class DirectFormClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

org.pac4j.core.client.DirectClient<UsernamePasswordCredentials>

org.pac4j.http.client.direct.DirectFormClient

All Implemented Interfaces:

Client<UsernamePasswordCredentials>

public class DirectFormClient
extends DirectClient<UsernamePasswordCredentials>

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

Since:

1.8.6

Author:

Jerome Leleu

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
DirectFormClient()
DirectFormClient(String usernameParameter, String passwordParameter, Authenticator usernamePasswordAuthenticator)
DirectFormClient(Authenticator usernamePasswordAuthenticator)
DirectFormClient(Authenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method	Description
protected void	clientInit()
String	getPasswordParameter()
String	getUsernameParameter()
void	setPasswordParameter(String passwordParameter)
void	setUsernameParameter(String usernameParameter)
String	toString()

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

getCredentials, getLogoutAction, getRedirectionAction, internalInit

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getUserProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated

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

init, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectFormClient

public DirectFormClient()

DirectFormClient

public DirectFormClient(Authenticator usernamePasswordAuthenticator)

DirectFormClient

public DirectFormClient(String usernameParameter,
                        String passwordParameter,
                        Authenticator usernamePasswordAuthenticator)

DirectFormClient

public DirectFormClient(Authenticator usernamePasswordAuthenticator,
                        ProfileCreator profileCreator)

Method Detail

clientInit

protected void clientInit()

Specified by:

clientInit in class DirectClient<UsernamePasswordCredentials>

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