de.xima.fc.web.common.auth.password

Class PasswordClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

org.pac4j.core.client.IndirectClient<PasswordCredentials>

de.xima.fc.web.common.auth.password.PasswordClient

All Implemented Interfaces:

org.pac4j.core.client.Client<PasswordCredentials>

public class PasswordClient
extends org.pac4j.core.client.IndirectClient<PasswordCredentials>

A client for authenticating with an project-spezific password

Author:

XIMA MEDIA GmbH

Field Summary

Fields

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

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver

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

logger

Constructor Summary

Constructors

Constructor and Description
PasswordClient(String loginUrl, Projekt project, Locale locale)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit()
protected String	computeErrorMessage(Exception e) Return the error message depending on the thrown exception.
String	getLoginUrl()
protected org.pac4j.core.exception.http.HttpAction	handleInvalidCredentials(org.pac4j.core.context.WebContext context, String message, String errorMessage)
protected Optional<PasswordCredentials>	retrieveCredentials(org.pac4j.core.context.WebContext context)
String	toString()

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

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, internalInit, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getUserProfile, notifySessionRenewal, renewUserProfile, 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

Field Detail

MISSING_FIELD_ERROR

public static final String MISSING_FIELD_ERROR

See Also:

Constant Field Values

ERROR_PARAMETER

public static final String ERROR_PARAMETER

See Also:

Constant Field Values

NAME

public static final String NAME

Constructor Detail

PasswordClient

public PasswordClient(String loginUrl,
                      Projekt project,
                      Locale locale)

Method Detail

getLoginUrl

public String getLoginUrl()

clientInit

protected void clientInit()

Specified by:

clientInit in class org.pac4j.core.client.IndirectClient<PasswordCredentials>

retrieveCredentials

protected Optional<PasswordCredentials> retrieveCredentials(org.pac4j.core.context.WebContext context)

Overrides:

retrieveCredentials in class org.pac4j.core.client.BaseClient<PasswordCredentials>

handleInvalidCredentials

protected org.pac4j.core.exception.http.HttpAction handleInvalidCredentials(org.pac4j.core.context.WebContext context,
                                                                            String message,
                                                                            String errorMessage)

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

toString

public String toString()

Overrides:

toString in class org.pac4j.core.client.IndirectClient<PasswordCredentials>