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
    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, org.pac4j.core.profile.factory.ProfileManagerFactory profileManagerFactory)
     

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

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

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

    addAuthorizationGenerator, addAuthorizationGenerators, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, isMultiProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, retrieveUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession

    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

    • 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, org.pac4j.core.profile.factory.ProfileManagerFactory profileManagerFactory)
      Overrides:
      retrieveCredentials in class org.pac4j.core.client.BaseClient