Package org.pac4j.http.client.direct

Class HeaderClient

  • All Implemented Interfaces:
    org.pac4j.core.client.Client
    public class HeaderClient
extends org.pac4j.core.client.DirectClient

    This class is the client to authenticate users directly based on a provided header.

    Since:
    1.8.0
    Author:
    Jerome Leleu

    • Field Summary

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

        logger, saveProfileInSession

    • Constructor Summary

      Constructors 
      Constructor Description
      HeaderClient()  
      HeaderClient​(java.lang.String headerName, java.lang.String prefixHeader, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)  
      HeaderClient​(java.lang.String headerName, java.lang.String prefixHeader, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)  
      HeaderClient​(java.lang.String headerName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)  
      HeaderClient​(java.lang.String headerName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getHeaderName()  
      java.lang.String getPrefixHeader()  
      protected void internalInit​(boolean forceReinit)  
      void setHeaderName​(java.lang.String headerName)  
      void setPrefixHeader​(java.lang.String prefixHeader)  
      java.lang.String toString()  

      • Methods inherited from class org.pac4j.core.client.DirectClient

        afterInternalInit, beforeInternalInit, getCredentials, getLogoutAction, getRedirectionAction

      • 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

      • HeaderClient

        public HeaderClient()

      • HeaderClient

        public HeaderClient​(java.lang.String headerName,
                    org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)

      • HeaderClient

        public HeaderClient​(java.lang.String headerName,
                    java.lang.String prefixHeader,
                    org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)

      • HeaderClient

        public HeaderClient​(java.lang.String headerName,
                    org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator,
                    org.pac4j.core.profile.creator.ProfileCreator profileCreator)

      • HeaderClient

        public HeaderClient​(java.lang.String headerName,
                    java.lang.String prefixHeader,
                    org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator,
                    org.pac4j.core.profile.creator.ProfileCreator profileCreator)

    • Method Detail

      • internalInit

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

      • getHeaderName

        public java.lang.String getHeaderName()

      • setHeaderName

        public void setHeaderName​(java.lang.String headerName)

      • getPrefixHeader

        public java.lang.String getPrefixHeader()

      • setPrefixHeader

        public void setPrefixHeader​(java.lang.String prefixHeader)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.pac4j.core.client.DirectClient