Package org.pac4j.http.client.direct

Class ParameterClient

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.ParameterClient

All Implemented Interfaces:

Client<TokenCredentials>

public class ParameterClient
extends DirectClient<TokenCredentials>

This class is the client to authenticate users directly based on a provided parameter (in a GET and/or POST request).

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
ParameterClient()
ParameterClient(String parameterName, Authenticator tokenAuthenticator)
ParameterClient(String parameterName, Authenticator tokenAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method	Description
protected void	clientInit()
String	getParameterName()
boolean	isSupportGetRequest()
boolean	isSupportPostRequest()
void	setParameterName(String parameterName)
void	setSupportGetRequest(boolean supportGetRequest)
void	setSupportPostRequest(boolean supportPostRequest)
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

ParameterClient

public ParameterClient()

ParameterClient

public ParameterClient(String parameterName,
                       Authenticator tokenAuthenticator)

ParameterClient

public ParameterClient(String parameterName,
                       Authenticator tokenAuthenticator,
                       ProfileCreator profileCreator)

Method Detail

clientInit

protected void clientInit()

Specified by:

clientInit in class DirectClient<TokenCredentials>

getParameterName

public String getParameterName()

setParameterName

public void setParameterName(String parameterName)

isSupportGetRequest

public boolean isSupportGetRequest()

setSupportGetRequest

public void setSupportGetRequest(boolean supportGetRequest)

isSupportPostRequest

public boolean isSupportPostRequest()

setSupportPostRequest

public void setSupportPostRequest(boolean supportPostRequest)

toString

public String toString()

Overrides:

toString in class BaseClient<TokenCredentials>