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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ERROR_PARAMETER |
static java.lang.String |
MISSING_FIELD_ERROR |
ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver
logger
Constructor and Description |
---|
FormClient() |
FormClient(java.lang.String loginUrl,
Authenticator usernamePasswordAuthenticator) |
FormClient(java.lang.String loginUrl,
Authenticator usernamePasswordAuthenticator,
ProfileCreator profileCreator) |
FormClient(java.lang.String loginUrl,
java.lang.String usernameParameter,
java.lang.String passwordParameter,
Authenticator usernamePasswordAuthenticator) |
Modifier and Type | Method and Description |
---|---|
protected void |
clientInit() |
protected java.lang.String |
computeErrorMessage(java.lang.Exception e)
Return the error message depending on the thrown exception.
|
java.lang.String |
getLoginUrl() |
java.lang.String |
getPasswordParameter() |
java.lang.String |
getUsernameParameter() |
protected HttpAction |
handleInvalidCredentials(WebContext context,
java.lang.String username,
java.lang.String message,
java.lang.String errorMessage) |
protected UsernamePasswordCredentials |
retrieveCredentials(WebContext context) |
void |
setLoginUrl(java.lang.String loginUrl) |
void |
setPasswordParameter(java.lang.String passwordParameter) |
void |
setUsernameParameter(java.lang.String usernameParameter) |
java.lang.String |
toString() |
computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, newDefaultCallbackUrlResolver, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver
addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getUserProfile, notifySessionRenewal, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator
init
public static final java.lang.String ERROR_PARAMETER
public static final java.lang.String MISSING_FIELD_ERROR
public FormClient()
public FormClient(java.lang.String loginUrl, Authenticator usernamePasswordAuthenticator)
public FormClient(java.lang.String loginUrl, java.lang.String usernameParameter, java.lang.String passwordParameter, Authenticator usernamePasswordAuthenticator)
public FormClient(java.lang.String loginUrl, Authenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)
protected void clientInit()
clientInit
in class IndirectClient<UsernamePasswordCredentials,CommonProfile>
protected UsernamePasswordCredentials retrieveCredentials(WebContext context)
retrieveCredentials
in class BaseClient<UsernamePasswordCredentials,CommonProfile>
protected HttpAction handleInvalidCredentials(WebContext context, java.lang.String username, java.lang.String message, java.lang.String errorMessage)
protected java.lang.String computeErrorMessage(java.lang.Exception e)
e
- the technical exceptionpublic java.lang.String getLoginUrl()
public void setLoginUrl(java.lang.String loginUrl)
public java.lang.String getUsernameParameter()
public void setUsernameParameter(java.lang.String usernameParameter)
public java.lang.String getPasswordParameter()
public void setPasswordParameter(java.lang.String passwordParameter)
public java.lang.String toString()
toString
in class IndirectClient<UsernamePasswordCredentials,CommonProfile>
Copyright © 2019. All Rights Reserved.