Package org.pac4j.http.client.indirect

Class IndirectBasicAuthClient

java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.IndirectClient
org.pac4j.http.client.indirect.IndirectBasicAuthClient
All Implemented Interfaces:
org.pac4j.core.client.Client
public class IndirectBasicAuthClient extends org.pac4j.core.client.IndirectClient

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

For authentication, the user is redirected to the callback url. If the user is not authenticated by basic auth, a specific exception : HttpAction is returned which must be handled by the application to force authentication.

Since:
1.8.0
Author:
Jerome Leleu

  • Field Summary

    Fields inherited from class org.pac4j.core.client.IndirectClient

    ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver

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

    logger, saveProfileInSession

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndirectBasicAuthClient()
     
    IndirectBasicAuthClient(String realmName, org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)
     
    IndirectBasicAuthClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)
     
    IndirectBasicAuthClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    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.IndirectClient

    afterInternalInit, beforeInternalInit, computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver

    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

    • IndirectBasicAuthClient

      public IndirectBasicAuthClient()

    • IndirectBasicAuthClient

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

    • IndirectBasicAuthClient

      public IndirectBasicAuthClient(String realmName, org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)

    • IndirectBasicAuthClient

      public IndirectBasicAuthClient(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

    • getRealmName

      public String getRealmName()

    • setRealmName

      public void setRealmName(String realmName)

    • toString

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