Package de.xima.fc.security.pac4j.client

Class ExtendedFormClient

  • All Implemented Interfaces:
    org.pac4j.core.client.Client
    public class ExtendedFormClient
extends org.pac4j.http.client.indirect.FormClient
    Extension of the default pac4j FormClient with the option of handling invalid credentials on AJAX authentication request with a custom IInvalidCredentialsHandler.
    Since:
    8.0.0
    Author:
    XIMA Media GmbH

    • Field Summary

      • Fields inherited from class org.pac4j.http.client.indirect.FormClient

        ERROR_PARAMETER, MISSING_FIELD_ERROR

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      ExtendedFormClient​(String loginUrl, String usernameParameter, String passwordParameter, org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.pac4j.core.exception.http.HttpAction handleInvalidCredentials​(org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore, String username, String message, String errorMessage)  
      Optional<org.pac4j.core.profile.UserProfile> renewUserProfile​(org.pac4j.core.profile.UserProfile profile, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)  
      void setInvalidAjaxCredentialsHandler​(IInvalidCredentialsHandler invalidCredentialsHandler)  

      • Methods inherited from class org.pac4j.http.client.indirect.FormClient

        computeErrorMessage, getLoginUrl, getPasswordParameter, getUsernameParameter, internalInit, retrieveCredentials, setLoginUrl, setPasswordParameter, setUsernameParameter, 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, 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

    • Constructor Detail

      • ExtendedFormClient

        public ExtendedFormClient​(String loginUrl,
                          String usernameParameter,
                          String passwordParameter,
                          org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)

    • Method Detail

      • setInvalidAjaxCredentialsHandler

        public void setInvalidAjaxCredentialsHandler​(IInvalidCredentialsHandler invalidCredentialsHandler)

      • renewUserProfile

        public Optional<org.pac4j.core.profile.UserProfile> renewUserProfile​(org.pac4j.core.profile.UserProfile profile,
                                                                     org.pac4j.core.context.WebContext context,
                                                                     org.pac4j.core.context.session.SessionStore sessionStore)
        Specified by:
        renewUserProfile in interface org.pac4j.core.client.Client
        Overrides:
        renewUserProfile 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 username,
                                                                            String message,
                                                                            String errorMessage)
        Overrides:
        handleInvalidCredentials in class org.pac4j.http.client.indirect.FormClient