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

Method Summary

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

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

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

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

addAuthorizationGenerator, addAuthorizationGenerators, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, isMultiProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, 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

IndirectBasicAuthClient

public IndirectBasicAuthClient()

Constructor for IndirectBasicAuthClient.

IndirectBasicAuthClient

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

Constructor for IndirectBasicAuthClient.

Parameters:

usernamePasswordAuthenticator - a Authenticator object

IndirectBasicAuthClient

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

Constructor for IndirectBasicAuthClient.

Parameters:

realmName - a String object

usernamePasswordAuthenticator - a Authenticator object

IndirectBasicAuthClient

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

Constructor for IndirectBasicAuthClient.

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

internalValidateCredentials

protected Optional<org.pac4j.core.credentials.Credentials> internalValidateCredentials(org.pac4j.core.context.CallContext ctx,
 org.pac4j.core.credentials.Credentials credentials)

Overrides:

internalValidateCredentials in class org.pac4j.core.client.BaseClient