Class CookieClient

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

    public class CookieClient
    extends org.pac4j.core.client.DirectClient
    Allows direct authentication based on a cookie.
    Since:
    1.8.0
    Author:
    Misagh Moayyed
    • Field Summary

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

        logger, saveProfileInSession
    • Constructor Summary

      Constructors 
      Constructor Description
      CookieClient()  
      CookieClient​(java.lang.String cookieName, org.pac4j.core.credentials.authenticator.Authenticator cookieAuthenticator)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCookieName()  
      protected void internalInit​(boolean forceReinit)  
      void setCookieName​(java.lang.String cookieName)  
      • Methods inherited from class org.pac4j.core.client.DirectClient

        afterInternalInit, beforeInternalInit, getCredentials, getLogoutAction, getRedirectionAction, toString
      • 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, retrieveCredentials, 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
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • CookieClient

        public CookieClient()
      • CookieClient

        public CookieClient​(java.lang.String cookieName,
                            org.pac4j.core.credentials.authenticator.Authenticator cookieAuthenticator)
    • Method Detail

      • internalInit

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

        public java.lang.String getCookieName()
      • setCookieName

        public void setCookieName​(java.lang.String cookieName)