org.pac4j.http.client

Class BasicAuthClient

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<UsernamePasswordCredentials,HttpProfile>

org.pac4j.http.client.BaseHttpClient

org.pac4j.http.client.BasicAuthClient

All Implemented Interfaces:

Cloneable, Client<UsernamePasswordCredentials,HttpProfile>

public class BasicAuthClient
extends BaseHttpClient

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

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.

The realm name can be defined using the setRealmName(String) method.

It returns a HttpProfile.

Since:

1.4.0

Author:

Jerome Leleu

See Also:

HttpProfile

Field Summary

Fields inherited from class org.pac4j.http.client.BaseHttpClient

usernamePasswordAuthenticator

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, logger, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
BasicAuthClient()
BasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator)
BasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator, ProfileCreator profilePopulator)

Method Summary

Methods

Modifier and Type	Method and Description
Mechanism	getMechanism()
String	getRealmName()
protected void	internalInit()
protected boolean	isDirectRedirection()
protected BaseClient<UsernamePasswordCredentials,HttpProfile>	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.BaseHttpClient

clone, getProfileCreator, getUsernamePasswordAuthenticator, retrieveUserProfile, setProfileCreator, setUsernamePasswordAuthenticator

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

addAuthorizationGenerator, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getRedirectAction, getRedirectionUrl, getStateParameter, getUserProfile, isEnableContextualRedirects, prependHostToUrlIfNotPresent, redirect, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setName

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

init, reinit

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthClient

public BasicAuthClient()

BasicAuthClient

public BasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator)

BasicAuthClient

public BasicAuthClient(UsernamePasswordAuthenticator usernamePasswordAuthenticator,
               ProfileCreator profilePopulator)

Method Detail

newClient

protected BaseClient<UsernamePasswordCredentials,HttpProfile> newClient()

Specified by:

newClient in class BaseClient<UsernamePasswordCredentials,HttpProfile>

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseHttpClient

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)

Specified by:

retrieveRedirectAction in class BaseClient<UsernamePasswordCredentials,HttpProfile>

retrieveCredentials

protected UsernamePasswordCredentials retrieveCredentials(WebContext context)
                                                   throws RequiresHttpAction

Specified by:

retrieveCredentials in class BaseClient<UsernamePasswordCredentials,HttpProfile>

Throws:

RequiresHttpAction

getRealmName

public String getRealmName()

setRealmName

public void setRealmName(String realmName)

toString

public String toString()

Overrides:

toString in class BaseClient<UsernamePasswordCredentials,HttpProfile>

isDirectRedirection

protected boolean isDirectRedirection()

Specified by:

isDirectRedirection in class BaseClient<UsernamePasswordCredentials,HttpProfile>

getMechanism

public Mechanism getMechanism()

Specified by:

getMechanism in class BaseClient<UsernamePasswordCredentials,HttpProfile>