Package org.pac4j.http.client.direct

Class HeaderClient

java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.DirectClient
org.pac4j.http.client.direct.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(String headerName, String prefixHeader, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)
     
    HeaderClient(String headerName, String prefixHeader, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
     
    HeaderClient(String headerName, String prefixHeader, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
     
    HeaderClient(String headerName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)
     
    HeaderClient(String headerName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
     
    HeaderClient(String headerName, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHeaderName()
     
    String
    getPrefixHeader()
     
    protected void
    internalInit(boolean forceReinit)
     
    void
    setHeaderName(String headerName)
     
    void
    setPrefixHeader(String prefixHeader)
     
    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 Details

    • HeaderClient

      public HeaderClient()

    • HeaderClient

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

    • HeaderClient

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

    • HeaderClient

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

    • HeaderClient

      public HeaderClient(String headerName, org.pac4j.core.profile.creator.ProfileCreator profileCreator)

    • HeaderClient

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

    • HeaderClient

      public HeaderClient(String headerName, String prefixHeader, org.pac4j.core.profile.creator.ProfileCreator profileCreator)

  • Method Details

    • internalInit

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

    • getHeaderName

      public String getHeaderName()

    • setHeaderName

      public void setHeaderName(String headerName)

    • getPrefixHeader

      public String getPrefixHeader()

    • setPrefixHeader

      public void setPrefixHeader(String prefixHeader)

    • toString

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