Class PasswordClient

  • All Implemented Interfaces:
    org.pac4j.core.client.Client

    public class PasswordClient
    extends org.pac4j.core.client.IndirectClient
    A client for authenticating with an project-spezific password
    Author:
    XIMA MEDIA GmbH
    • Field Summary

      Fields 
      Modifier and Type Field 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, saveProfileInSession
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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, org.pac4j.core.context.session.SessionStore sessionStore, String message, String errorMessage)  
      protected void internalInit​(boolean forceReinit)  
      protected Optional<org.pac4j.core.credentials.Credentials> retrieveCredentials​(org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)  
      String toString()  
      • Methods inherited from class org.pac4j.core.client.IndirectClient

        afterInternalInit, beforeInternalInit, computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver
      • Methods inherited from class org.pac4j.core.client.BaseClient

        addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getUserProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession
      • Methods inherited from class org.pac4j.core.util.InitializableObject

        getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize
    • Method Detail

      • getLoginUrl

        public String getLoginUrl()
      • internalInit

        protected void internalInit​(boolean forceReinit)
        Specified by:
        internalInit in class org.pac4j.core.util.InitializableObject
      • retrieveCredentials

        protected Optional<org.pac4j.core.credentials.Credentials> retrieveCredentials​(org.pac4j.core.context.WebContext context,
                                                                                       org.pac4j.core.context.session.SessionStore sessionStore)
        Overrides:
        retrieveCredentials in class org.pac4j.core.client.BaseClient
      • handleInvalidCredentials

        protected org.pac4j.core.exception.http.HttpAction handleInvalidCredentials​(org.pac4j.core.context.WebContext context,
                                                                                    org.pac4j.core.context.session.SessionStore sessionStore,
                                                                                    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