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<C,HttpProfile>

org.pac4j.http.client.indirect.IndirectHttpClient<UsernamePasswordCredentials>

org.pac4j.http.client.indirect.IndirectBasicAuthClient

All Implemented Interfaces:

Cloneable, Client<UsernamePasswordCredentials,HttpProfile>

Direct Known Subclasses:

BasicAuthClient

public class IndirectBasicAuthClient
extends IndirectHttpClient<UsernamePasswordCredentials>

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 : RequiresHttpAction is returned which must be handled by the application to force authentication.

It returns a HttpProfile.

Since:

1.8.0

Author:

Jerome Leleu

See Also:

HttpProfile

Field Summary

Fields inherited from class org.pac4j.http.client.indirect.IndirectHttpClient

extractor

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, NEEDS_CLIENT_REDIRECTION_PARAMETER

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

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IndirectBasicAuthClient	clone()
ClientType	getClientType()
String	getRealmName()
protected void	internalInit(WebContext context)
protected boolean	isDirectRedirection()
protected IndirectBasicAuthClient	newClient()
protected UsernamePasswordCredentials	retrieveCredentials(WebContext context)
protected RedirectAction	retrieveRedirectAction(WebContext context)
void	setRealmName(String realmName)
String	toString()

Methods inherited from class org.pac4j.http.client.indirect.IndirectHttpClient

getAuthenticator, getProfileCreator, retrieveUserProfile, setAuthenticator, setProfileCreator

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

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getRedirectionUrl, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl

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

IndirectBasicAuthClient

public IndirectBasicAuthClient()

IndirectBasicAuthClient

public IndirectBasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator)

IndirectBasicAuthClient

public IndirectBasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator,
                               ProfileCreator profileCreator)

Method Detail

internalInit

protected void internalInit(WebContext context)

Overrides:

internalInit in class IndirectHttpClient<UsernamePasswordCredentials>

clone

public IndirectBasicAuthClient clone()

Overrides:

clone in class IndirectHttpClient<UsernamePasswordCredentials>

newClient

protected IndirectBasicAuthClient newClient()

Specified by:

newClient in class BaseClient<UsernamePasswordCredentials,HttpProfile>

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)

Specified by:

retrieveRedirectAction in class IndirectClient<UsernamePasswordCredentials,HttpProfile>

retrieveCredentials

protected UsernamePasswordCredentials retrieveCredentials(WebContext context)
                                                   throws RequiresHttpAction

Specified by:

retrieveCredentials in class IndirectClient<UsernamePasswordCredentials,HttpProfile>

Throws:

RequiresHttpAction

toString

public String toString()

Overrides:

toString in class BaseClient<UsernamePasswordCredentials,HttpProfile>

isDirectRedirection

protected boolean isDirectRedirection()

Specified by:

isDirectRedirection in class IndirectClient<UsernamePasswordCredentials,HttpProfile>

getClientType

public ClientType getClientType()

Specified by:

getClientType in class BaseClient<UsernamePasswordCredentials,HttpProfile>

getRealmName

public String getRealmName()

setRealmName

public void setRealmName(String realmName)