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

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addAuthenticateHeader(org.pac4j.core.context.WebContext context)
    addAuthenticateHeader.
    Optional<org.pac4j.core.credentials.Credentials>
    getCredentials(org.pac4j.core.context.CallContext ctx)
    protected void
    internalInit(boolean forceReinit)

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

    afterInternalInit, beforeInternalInit, getLogoutAction, getRedirectionAction, processLogout

    Methods inherited from class org.pac4j.core.client.BaseClient

    addAuthorizationGenerator, addAuthorizationGenerators, checkCredentials, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, toString, validateCredentials

    Methods inherited from class org.pac4j.core.util.InitializableObject

    getInitialized, 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()

      Constructor for DirectBasicAuthClient.

    • DirectBasicAuthClient

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

      Constructor for DirectBasicAuthClient.

      Parameters:
      usernamePasswordAuthenticator - a Authenticator object

    • DirectBasicAuthClient

      public DirectBasicAuthClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)

      Constructor for DirectBasicAuthClient.

      Parameters:
      usernamePasswordAuthenticator - a Authenticator object
      profileCreator - a ProfileCreator object

  • Method Details

    • internalInit

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

    • getCredentials

      public Optional<org.pac4j.core.credentials.Credentials> getCredentials(org.pac4j.core.context.CallContext ctx)
      Specified by:
      getCredentials in interface org.pac4j.core.client.Client
      Overrides:
      getCredentials in class org.pac4j.core.client.BaseClient

    • addAuthenticateHeader

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

      addAuthenticateHeader.

      Parameters:
      context - a WebContext object