Package org.pac4j.http.client.direct

Class DirectBasicAuthClient

java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.DirectClient
org.pac4j.http.client.direct.DirectBasicAuthClient
All Implemented Interfaces:
org.pac4j.core.client.Client
public class DirectBasicAuthClient extends org.pac4j.core.client.DirectClient

This class is the client to authenticate users directly through HTTP basic auth.

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
    DirectBasicAuthClient()
     
    DirectBasicAuthClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)
     
    DirectBasicAuthClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addAuthenticateHeader(org.pac4j.core.context.WebContext context)
     
    String
    getRealmName()
     
    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)
     
    void
    setRealmName(String realmName)
     
    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, 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

    • DirectBasicAuthClient

      public DirectBasicAuthClient()

    • DirectBasicAuthClient

      public DirectBasicAuthClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)

    • DirectBasicAuthClient

      public DirectBasicAuthClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator, 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

    • 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

    • addAuthenticateHeader

      protected void addAuthenticateHeader(org.pac4j.core.context.WebContext context)

    • getRealmName

      public String getRealmName()

    • setRealmName

      public void setRealmName(String realmName)

    • toString

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