org.pac4j.http.client.direct

Class HeaderClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

org.pac4j.core.client.DirectClientV2<TokenCredentials,CommonProfile>

org.pac4j.http.client.direct.HeaderClient

All Implemented Interfaces:

Client<TokenCredentials,CommonProfile>

public class HeaderClient
extends DirectClientV2<TokenCredentials,CommonProfile>

This class is the client to authenticate users directly based on a provided header.

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
HeaderClient()
HeaderClient(Authenticator tokenAuthenticator) Deprecated.
HeaderClient(Authenticator tokenAuthenticator, ProfileCreator profileCreator) Deprecated.
HeaderClient(String headerName, Authenticator tokenAuthenticator)
HeaderClient(String headerName, Authenticator tokenAuthenticator, ProfileCreator profileCreator)
HeaderClient(String headerName, String prefixHeader, Authenticator tokenAuthenticator)
HeaderClient(String headerName, String prefixHeader, Authenticator tokenAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method and Description
String	getHeaderName()
String	getPrefixHeader()
protected void	internalInit(WebContext context)
void	setHeaderName(String headerName)
void	setPrefixHeader(String prefixHeader)
String	toString()

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

getAuthenticator, getCredentialsExtractor, getProfileCreator, retrieveCredentials, retrieveUserProfile, setAuthenticator, setCredentialsExtractor, setProfileCreator

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

getCredentials, redirect

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

addAuthorizationGenerator, addAuthorizationGenerators, 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

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

Constructor Detail

HeaderClient

public HeaderClient()

HeaderClient

@Deprecated
public HeaderClient(Authenticator tokenAuthenticator)

Deprecated.

HeaderClient

public HeaderClient(String headerName,
                    Authenticator tokenAuthenticator)

HeaderClient

public HeaderClient(String headerName,
                    String prefixHeader,
                    Authenticator tokenAuthenticator)

HeaderClient

@Deprecated
public HeaderClient(Authenticator tokenAuthenticator,
                                ProfileCreator profileCreator)

Deprecated.

HeaderClient

public HeaderClient(String headerName,
                    Authenticator tokenAuthenticator,
                    ProfileCreator profileCreator)

HeaderClient

public HeaderClient(String headerName,
                    String prefixHeader,
                    Authenticator tokenAuthenticator,
                    ProfileCreator profileCreator)

Method Detail

internalInit

protected void internalInit(WebContext context)

Specified by:

internalInit in class InitializableWebObject

getHeaderName

public String getHeaderName()

setHeaderName

public void setHeaderName(String headerName)

getPrefixHeader

public String getPrefixHeader()

setPrefixHeader

public void setPrefixHeader(String prefixHeader)

toString

public String toString()

Overrides:

toString in class DirectClientV2<TokenCredentials,CommonProfile>