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

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

org.pac4j.http.client.direct.ParameterClient

All Implemented Interfaces:

Client<TokenCredentials,CommonProfile>

public class ParameterClient
extends DirectClientV2<TokenCredentials,CommonProfile>

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 and Description
ParameterClient()
ParameterClient(String parameterName, Authenticator tokenAuthenticator)
ParameterClient(String parameterName, Authenticator tokenAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method and Description
String	getParameterName()
protected void	internalInit(WebContext context) Internal initialization of the object.
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.DirectClientV2

assertAuthenticatorTypes, getAuthenticator, getCredentials, getCredentialsExtractor, getProfileCreator, retrieveUserProfile, setAuthenticator, setCredentialsExtractor, setProfileCreator

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

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

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class DirectClientV2<TokenCredentials,CommonProfile>

Parameters:

context - the web context

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 DirectClientV2<TokenCredentials,CommonProfile>