org.pac4j.http.client.direct

Class ParameterClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

org.pac4j.http.client.direct.DirectHttpClient<TokenCredentials>

org.pac4j.http.client.direct.ParameterClient

All Implemented Interfaces:

Cloneable, Client<TokenCredentials,CommonProfile>

public class ParameterClient
extends DirectHttpClient<TokenCredentials>

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

It returns a HttpProfile.

Since:

1.8.0

Author:

Jerome Leleu

See Also:

HttpProfile

Field Summary

Fields inherited from class org.pac4j.http.client.direct.DirectHttpClient

extractor

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

logger

Constructor Summary

Constructors

Constructor and Description
ParameterClient()
ParameterClient(String parameterName, TokenAuthenticator tokenAuthenticator)
ParameterClient(String parameterName, TokenAuthenticator tokenAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method and Description
ClientType	getClientType() Return the client type.
String	getParameterName()
protected void	internalInit(WebContext context) Internal initialization of the object.
boolean	isSupportGetRequest()
boolean	isSupportPostRequest()
protected ParameterClient	newClient() Create a new instance of the client.
void	setParameterName(String parameterName)
void	setSupportGetRequest(boolean supportGetRequest)
void	setSupportPostRequest(boolean supportPostRequest)

Methods inherited from class org.pac4j.http.client.direct.DirectHttpClient

clone, getAuthenticator, getCredentials, getProfileCreator, retrieveUserProfile, setAuthenticator, setProfileCreator, toString

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

redirect

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

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

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

Constructor Detail

ParameterClient

public ParameterClient()

ParameterClient

public ParameterClient(String parameterName,
                       TokenAuthenticator tokenAuthenticator)

ParameterClient

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

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class DirectHttpClient<TokenCredentials>

Parameters:

context - the web context

newClient

protected ParameterClient newClient()

Description copied from class: BaseClient

Create a new instance of the client.

Specified by:

newClient in class BaseClient<TokenCredentials,CommonProfile>

Returns:

A new instance of the client

getClientType

public ClientType getClientType()

Description copied from class: BaseClient

Return the client type.

Specified by:

getClientType in class BaseClient<TokenCredentials,CommonProfile>

Returns:

the client type

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)