Package org.pac4j.http.client.direct

Class DirectBasicAuthClient

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<C>

org.pac4j.core.client.DirectClient<UsernamePasswordCredentials>

org.pac4j.http.client.direct.DirectBasicAuthClient

All Implemented Interfaces:

Client<UsernamePasswordCredentials>

public class DirectBasicAuthClient
extends DirectClient<UsernamePasswordCredentials>

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

Constructor Summary

Constructors

Constructor	Description
DirectBasicAuthClient()
DirectBasicAuthClient(Authenticator usernamePasswordAuthenticator)
DirectBasicAuthClient(Authenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method	Description
protected void	addAuthenticateHeader(WebContext context)
protected void	clientInit()
String	getRealmName()
protected Optional<UsernamePasswordCredentials>	retrieveCredentials(WebContext context)
void	setRealmName(String realmName)
String	toString()

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

getCredentials, getLogoutAction, getRedirectionAction, internalInit

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getUserProfile, notifySessionRenewal, renewUserProfile, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated

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(Authenticator usernamePasswordAuthenticator)

DirectBasicAuthClient

public DirectBasicAuthClient(Authenticator usernamePasswordAuthenticator,
                             ProfileCreator profileCreator)

Method Detail

clientInit

protected void clientInit()

Specified by:

clientInit in class DirectClient<UsernamePasswordCredentials>

retrieveCredentials

protected Optional<UsernamePasswordCredentials> retrieveCredentials(WebContext context)

Overrides:

retrieveCredentials in class BaseClient<UsernamePasswordCredentials>

addAuthenticateHeader

protected void addAuthenticateHeader(WebContext context)

getRealmName

public String getRealmName()

setRealmName

public void setRealmName(String realmName)

toString

public String toString()

Overrides:

toString in class BaseClient<UsernamePasswordCredentials>