org.pac4j.http.client.indirect

Class FormClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

org.pac4j.http.client.indirect.FormClient

All Implemented Interfaces:

Client<UsernamePasswordCredentials,CommonProfile>

public class FormClient
extends IndirectClient<UsernamePasswordCredentials,CommonProfile>

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.

Since:

1.4.0

Author:

Jerome Leleu

Field Summary

Fields

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

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, urlResolver

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

logger

Constructor Summary

Constructors

Constructor and Description
FormClient()
FormClient(String loginUrl, Authenticator usernamePasswordAuthenticator)
FormClient(String loginUrl, Authenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)
FormClient(String loginUrl, String usernameParameter, String passwordParameter, Authenticator usernamePasswordAuthenticator)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit(WebContext context) Initialize the client.
protected String	computeErrorMessage(Exception e) Return the error message depending on the thrown exception.
String	getLoginUrl()
String	getPasswordParameter()
String	getUsernameParameter()
protected HttpAction	handleInvalidCredentials(WebContext context, String username, String message, String errorMessage)
protected UsernamePasswordCredentials	retrieveCredentials(WebContext context) Retrieve the credentials.
void	setLoginUrl(String loginUrl)
void	setPasswordParameter(String passwordParameter)
void	setUsernameParameter(String usernameParameter)
String	toString()

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

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getName, getProfileCreator, getUserProfile, notifySessionRenewal, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setName, setProfileCreator

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

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

Constructor Detail

FormClient

public FormClient()

FormClient

public FormClient(String loginUrl,
                  Authenticator usernamePasswordAuthenticator)

FormClient

public FormClient(String loginUrl,
                  String usernameParameter,
                  String passwordParameter,
                  Authenticator usernamePasswordAuthenticator)

FormClient

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

Method Detail

clientInit

protected void clientInit(WebContext context)

Description copied from class: IndirectClient

Initialize the client.

Specified by:

clientInit in class IndirectClient<UsernamePasswordCredentials,CommonProfile>

Parameters:

context - the web context

retrieveCredentials

protected UsernamePasswordCredentials retrieveCredentials(WebContext context)
                                                   throws HttpAction

Description copied from class: BaseClient

Retrieve the credentials.

Overrides:

retrieveCredentials in class BaseClient<UsernamePasswordCredentials,CommonProfile>

Parameters:

context - the web context

Returns:

the credentials

Throws:

HttpAction - whether an additional HTTP action is required

handleInvalidCredentials

protected HttpAction handleInvalidCredentials(WebContext context,
                                              String username,
                                              String message,
                                              String errorMessage)
                                       throws HttpAction

Throws:

HttpAction

computeErrorMessage

protected String computeErrorMessage(Exception e)

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

Parameters:

e - the technical exception

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