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,U>

org.pac4j.core.client.DirectClientV2<UsernamePasswordCredentials,CommonProfile>

org.pac4j.http.client.direct.DirectFormClient

All Implemented Interfaces:

Client<UsernamePasswordCredentials,CommonProfile>

public class DirectFormClient
extends DirectClientV2<UsernamePasswordCredentials,CommonProfile>

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 and Description
DirectFormClient()
DirectFormClient(Authenticator usernamePasswordAuthenticator)
DirectFormClient(Authenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)
DirectFormClient(String usernameParameter, String passwordParameter, Authenticator usernamePasswordAuthenticator)

Method Summary

Modifier and Type	Method and Description
String	getPasswordParameter()
String	getUsernameParameter()
protected void	internalInit(WebContext context) Internal initialization of the object.
void	setPasswordParameter(String passwordParameter)
void	setUsernameParameter(String usernameParameter)
String	toString()

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

getAuthenticator, getCredentialsExtractor, getProfileCreator, retrieveCredentials, retrieveUserProfile, setAuthenticator, setCredentialsExtractor, setProfileCreator

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

getCredentials, redirect

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

addAuthorizationGenerator, addAuthorizationGenerators, 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

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

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

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 DirectClientV2<UsernamePasswordCredentials,CommonProfile>