org.pac4j.http.client.indirect

Class IndirectBasicAuthClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

org.pac4j.http.client.indirect.IndirectBasicAuthClient

All Implemented Interfaces:

Client<UsernamePasswordCredentials,CommonProfile>

public class IndirectBasicAuthClient
extends IndirectClient<UsernamePasswordCredentials,CommonProfile>

This class is the client to authenticate users through HTTP basic auth. It was previously named: BasicAuthClient.

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, urlResolver

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

logger

Constructor Summary

Constructors

Constructor and Description
IndirectBasicAuthClient()
IndirectBasicAuthClient(Authenticator usernamePasswordAuthenticator)
IndirectBasicAuthClient(Authenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)
IndirectBasicAuthClient(String realmName, Authenticator usernamePasswordAuthenticator)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit(WebContext context) 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.IndirectClient

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver

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

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

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

init, reinit

Methods inherited from class java.lang.Object

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

Constructor Detail

IndirectBasicAuthClient

public IndirectBasicAuthClient()

IndirectBasicAuthClient

public IndirectBasicAuthClient(Authenticator usernamePasswordAuthenticator)

IndirectBasicAuthClient

public IndirectBasicAuthClient(String realmName,
                               Authenticator usernamePasswordAuthenticator)

IndirectBasicAuthClient

public IndirectBasicAuthClient(Authenticator usernamePasswordAuthenticator,
                               ProfileCreator profileCreator)

Method Detail

clientInit

protected void clientInit(WebContext context)

Description copied from class: IndirectClient

Initialize the client.

Specified by:

clientInit in class IndirectClient<UsernamePasswordCredentials,CommonProfile>

Parameters:

context - the web context

retrieveCredentials

protected UsernamePasswordCredentials retrieveCredentials(WebContext context)
                                                   throws HttpAction

Description copied from class: BaseClient

Retrieve the credentials.

Overrides:

retrieveCredentials in class BaseClient<UsernamePasswordCredentials,CommonProfile>

Parameters:

context - the web context

Returns:

the credentials

Throws:

HttpAction - whether an additional HTTP action is required

getRealmName

public String getRealmName()

setRealmName

public void setRealmName(String realmName)

toString

public String toString()

Overrides:

toString in class IndirectClient<UsernamePasswordCredentials,CommonProfile>