Package org.pac4j.http.client.direct

Class HeaderClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

org.pac4j.core.client.DirectClient<TokenCredentials>

org.pac4j.http.client.direct.HeaderClient

All Implemented Interfaces:

Client<TokenCredentials>

public class HeaderClient
extends DirectClient<TokenCredentials>

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	Description
HeaderClient()
HeaderClient(String headerName, String prefixHeader, Authenticator tokenAuthenticator)
HeaderClient(String headerName, String prefixHeader, Authenticator tokenAuthenticator, ProfileCreator profileCreator)
HeaderClient(String headerName, Authenticator tokenAuthenticator)
HeaderClient(String headerName, Authenticator tokenAuthenticator, ProfileCreator profileCreator)

Method Summary

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

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

getCredentials, getLogoutAction, getRedirectionAction, internalInit

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getUserProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated

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

init, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderClient

public HeaderClient()

HeaderClient

public HeaderClient(String headerName,
                    Authenticator tokenAuthenticator)

HeaderClient

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

HeaderClient

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

HeaderClient

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

Method Detail

clientInit

protected void clientInit()

Specified by:

clientInit in class DirectClient<TokenCredentials>

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 BaseClient<TokenCredentials>