org.pac4j.http.client

Class AbstractHeaderClient<C extends Credentials>

java.lang.Object

org.pac4j.core.util.InitializableObject

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

org.pac4j.http.client.BaseHttpClient<C>

org.pac4j.http.client.AbstractHeaderClient<C>

All Implemented Interfaces:

Cloneable, Client<C,HttpProfile>

Direct Known Subclasses:

BasicAuthClient

public abstract class AbstractHeaderClient<C extends Credentials>
extends BaseHttpClient<C>

This class is the client to authenticate users through HTTP given a provided header.

For authentication, the user is redirected to the callback url. If the user is not authenticated by a provided header, a specific exception : RequiresHttpAction is returned which must be handled by the application to force authentication.

It returns a HttpProfile.

Since:

1.7.0

Author:

Jerome Leleu

See Also:

HttpProfile

Field Summary

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, logger, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
AbstractHeaderClient()
AbstractHeaderClient(Authenticator<C> authenticator)
AbstractHeaderClient(Authenticator<C> authenticator, ProfileCreator<C,HttpProfile> profilePopulator)

Method Summary

Modifier and Type	Method and Description
String	getHeaderName()
String	getPrefixHeader()
String	getRealmName()
protected void	internalInit()
protected boolean	isDirectRedirection()
protected C	retrieveCredentials(WebContext context)
protected abstract C	retrieveCredentialsFromHeader(String header)
protected RedirectAction	retrieveRedirectAction(WebContext context)
void	setHeaderName(String headerName)
void	setPrefixHeader(String prefixHeader)
void	setRealmName(String realmName)

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

retrieveUserProfile

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

addAuthorizationGenerator, clone, getAuthenticator, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getMechanism, getName, getProfileCreator, getRedirectAction, getRedirectionUrl, getStateParameter, getUserProfile, isEnableContextualRedirects, newClient, prependHostToUrlIfNotPresent, redirect, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setName, setProfileCreator, toString

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

AbstractHeaderClient

public AbstractHeaderClient()

AbstractHeaderClient

public AbstractHeaderClient(Authenticator<C> authenticator)

AbstractHeaderClient

public AbstractHeaderClient(Authenticator<C> authenticator,
                            ProfileCreator<C,HttpProfile> profilePopulator)

Method Detail

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseHttpClient<C extends Credentials>

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)

Specified by:

retrieveRedirectAction in class BaseClient<C extends Credentials,HttpProfile>

retrieveCredentials

protected C retrieveCredentials(WebContext context)
                         throws RequiresHttpAction

Specified by:

retrieveCredentials in class BaseClient<C extends Credentials,HttpProfile>

Throws:

RequiresHttpAction

retrieveCredentialsFromHeader

protected abstract C retrieveCredentialsFromHeader(String header)

isDirectRedirection

protected boolean isDirectRedirection()

Specified by:

isDirectRedirection in class BaseClient<C extends Credentials,HttpProfile>

getHeaderName

public String getHeaderName()

setHeaderName

public void setHeaderName(String headerName)

getPrefixHeader

public String getPrefixHeader()

setPrefixHeader

public void setPrefixHeader(String prefixHeader)

getRealmName

public String getRealmName()

setRealmName

public void setRealmName(String realmName)