Package org.pac4j.http.client.direct

Class 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addAuthenticateHeader​(org.pac4j.core.context.WebContext context)  
      java.lang.String getRealmName()  
      protected void internalInit()  
      protected java.util.Optional<org.pac4j.core.credentials.Credentials> retrieveCredentials​(org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)  
      void setRealmName​(java.lang.String realmName)  
      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, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession

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

        init, isInitialized

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • 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 Detail

      • internalInit

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

      • retrieveCredentials

        protected java.util.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 java.lang.String getRealmName()

      • setRealmName

        public void setRealmName​(java.lang.String realmName)

      • toString

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