org.pac4j.http.client

Class FormClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

org.pac4j.http.client.BaseHttpClient

org.pac4j.http.client.FormClient

All Implemented Interfaces:

Cloneable, Client<UsernamePasswordCredentials,HttpProfile>

public class FormClient
extends BaseHttpClient

This class is the client to authenticate users through HTTP form.

The login url of the form must be defined through the setLoginUrl(String) method. For authentication, the user is redirected to this login form. The username and password inputs must be posted on the callback url. Their names can be defined by using the setUsernameParameter(String) and setPasswordParameter(String) methods.

It returns a HttpProfile.

Since:

1.4.0

Author:

Jerome Leleu

See Also:

HttpProfile

Field Summary

Fields

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

Fields inherited from class org.pac4j.http.client.BaseHttpClient

usernamePasswordAuthenticator

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

callbackUrl, logger, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
FormClient()
FormClient(String loginUrl, UsernamePasswordAuthenticator usernamePasswordAuthenticator)
FormClient(String loginUrl, UsernamePasswordAuthenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	computeErrorMessage(TechnicalException e) Return the error message depending on the thrown exception.
String	getLoginUrl()
String	getPasswordParameter()
String	getUsernameParameter()
protected void	internalInit()
protected boolean	isDirectRedirection()
protected BaseClient<UsernamePasswordCredentials,HttpProfile>	newClient()
protected UsernamePasswordCredentials	retrieveCredentials(WebContext context)
protected String	retrieveRedirectionUrl(WebContext context)
void	setLoginUrl(String loginUrl)
void	setPasswordParameter(String passwordParameter)
void	setUsernameParameter(String usernameParameter)
String	toString()

Methods inherited from class org.pac4j.http.client.BaseHttpClient

clone, getProfileCreator, getProtocol, getUsernamePasswordAuthenticator, retrieveUserProfile, setProfileCreator, setUsernamePasswordAuthenticator

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

getCallbackUrl, getCredentials, getName, getRedirectionUrl, getRedirectionUrl, getUserProfile, setCallbackUrl, setName

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

ERROR_PARAMETER

public static final String ERROR_PARAMETER

See Also:

Constant Field Values

MISSING_FIELD_ERROR

public static final String MISSING_FIELD_ERROR

See Also:

Constant Field Values

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

FormClient

public FormClient()

FormClient

public FormClient(String loginUrl,
          UsernamePasswordAuthenticator usernamePasswordAuthenticator)

FormClient

public FormClient(String loginUrl,
          UsernamePasswordAuthenticator usernamePasswordAuthenticator,
          ProfileCreator profileCreator)

Method Detail

newClient

protected BaseClient<UsernamePasswordCredentials,HttpProfile> newClient()

Specified by:

newClient in class BaseClient<UsernamePasswordCredentials,HttpProfile>

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseHttpClient

retrieveRedirectionUrl

protected String retrieveRedirectionUrl(WebContext context)

Specified by:

retrieveRedirectionUrl in class BaseClient<UsernamePasswordCredentials,HttpProfile>

retrieveCredentials

protected UsernamePasswordCredentials retrieveCredentials(WebContext context)
                                                   throws RequiresHttpAction

Specified by:

retrieveCredentials in class BaseClient<UsernamePasswordCredentials,HttpProfile>

Throws:

RequiresHttpAction

computeErrorMessage

protected String computeErrorMessage(TechnicalException e)

Return the error message depending on the thrown exception. Can be overriden for other message computation.

Parameters:

e -

Returns:

the error message

getLoginUrl

public String getLoginUrl()

setLoginUrl

public void setLoginUrl(String loginUrl)

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

isDirectRedirection

protected boolean isDirectRedirection()

Specified by:

isDirectRedirection in class BaseClient<UsernamePasswordCredentials,HttpProfile>