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
-
-
Constructor Summary
Constructors Constructor Description IndirectBasicAuthClient()
IndirectBasicAuthClient(java.lang.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getRealmName()
protected void
internalInit(boolean forceReinit)
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.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
-
-
-
-
Constructor Detail
-
IndirectBasicAuthClient
public IndirectBasicAuthClient()
-
IndirectBasicAuthClient
public IndirectBasicAuthClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)
-
IndirectBasicAuthClient
public IndirectBasicAuthClient(java.lang.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 Detail
-
internalInit
protected void internalInit(boolean forceReinit)
- Specified by:
internalInit
in classorg.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 classorg.pac4j.core.client.BaseClient
-
getRealmName
public java.lang.String getRealmName()
-
setRealmName
public void setRealmName(java.lang.String realmName)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classorg.pac4j.core.client.IndirectClient
-
-