org.pac4j.http.client.direct

Class DirectBasicAuthClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

org.pac4j.http.client.direct.DirectBasicAuthClient

All Implemented Interfaces:

Client<UsernamePasswordCredentials,CommonProfile>

public class DirectBasicAuthClient
extends DirectClient<UsernamePasswordCredentials,CommonProfile>

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 and Description
DirectBasicAuthClient()
DirectBasicAuthClient(Authenticator usernamePasswordAuthenticator)
DirectBasicAuthClient(Authenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit() Initialize the client.
String	getRealmName()
protected UsernamePasswordCredentials	retrieveCredentials(WebContext context) Retrieve the credentials.
void	setRealmName(String realmName)
String	toString()

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

getCredentials, getLogoutAction, internalInit, redirect

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

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

Methods inherited from class org.pac4j.core.util.InitializableObject

init

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

Description copied from class: DirectClient

Initialize the client.

Specified by:

clientInit in class DirectClient<UsernamePasswordCredentials,CommonProfile>

retrieveCredentials

protected UsernamePasswordCredentials retrieveCredentials(WebContext context)

Description copied from class: BaseClient

Retrieve the credentials.

Overrides:

retrieveCredentials in class BaseClient<UsernamePasswordCredentials,CommonProfile>

Parameters:

context - the web context

Returns:

the credentials

getRealmName

public String getRealmName()

setRealmName

public void setRealmName(String realmName)

toString

public String toString()

Overrides:

toString in class BaseClient<UsernamePasswordCredentials,CommonProfile>