org.pac4j.http.client.direct

Class DirectBasicAuthClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

org.pac4j.http.client.direct.DirectHttpClient<UsernamePasswordCredentials>

org.pac4j.http.client.direct.DirectBasicAuthClient

All Implemented Interfaces:

Cloneable, Client<UsernamePasswordCredentials,CommonProfile>

public class DirectBasicAuthClient
extends DirectHttpClient<UsernamePasswordCredentials>

This class is the client to authenticate users directly through HTTP basic auth.

It returns a HttpProfile.

Since:

1.8.0

Author:

Jerome Leleu

See Also:

HttpProfile

Field Summary

Fields inherited from class org.pac4j.http.client.direct.DirectHttpClient

extractor

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

logger

Constructor Summary

Constructors

Constructor and Description
DirectBasicAuthClient()
DirectBasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator)
DirectBasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method and Description
ClientType	getClientType() Return the client type.
protected void	internalInit(WebContext context) Internal initialization of the object.
protected DirectBasicAuthClient	newClient() Create a new instance of the client.

Methods inherited from class org.pac4j.http.client.direct.DirectHttpClient

clone, getAuthenticator, getCredentials, getProfileCreator, retrieveUserProfile, setAuthenticator, setProfileCreator, toString

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

redirect

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

addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName

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

init, reinit

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DirectBasicAuthClient

public DirectBasicAuthClient()

DirectBasicAuthClient

public DirectBasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator)

DirectBasicAuthClient

public DirectBasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator,
                             ProfileCreator profileCreator)

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class DirectHttpClient<UsernamePasswordCredentials>

Parameters:

context - the web context

newClient

protected DirectBasicAuthClient newClient()

Description copied from class: BaseClient

Create a new instance of the client.

Specified by:

newClient in class BaseClient<UsernamePasswordCredentials,CommonProfile>

Returns:

A new instance of the client

getClientType

public ClientType getClientType()

Description copied from class: BaseClient

Return the client type.

Specified by:

getClientType in class BaseClient<UsernamePasswordCredentials,CommonProfile>

Returns:

the client type