Package org.pac4j.core.credentials.extractor

Class ParameterExtractor

java.lang.Object

org.pac4j.core.credentials.extractor.ParameterExtractor

All Implemented Interfaces:

CredentialsExtractor

public class ParameterExtractor
extends Object
implements CredentialsExtractor

To extract a parameter value.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor	Description
ParameterExtractor(String parameterName)	Constructor for ParameterExtractor.
ParameterExtractor(String parameterName, boolean supportGetRequest, boolean supportPostRequest)	Constructor for ParameterExtractor.

Method Summary

Modifier and Type	Method	Description
Optional<Credentials>	extract(CallContext ctx)	Extract the Credentials from a WebContext and return Optional.empty() if no credentials are present or throw a CredentialsException if it cannot get it.

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterExtractor

public ParameterExtractor(String parameterName)

Constructor for ParameterExtractor.

Parameters:

parameterName - a String object

ParameterExtractor

public ParameterExtractor(String parameterName,
 boolean supportGetRequest,
 boolean supportPostRequest)

Constructor for ParameterExtractor.

Parameters:

parameterName - a String object

supportGetRequest - a boolean

supportPostRequest - a boolean

Method Details

extract

public Optional<Credentials> extract(CallContext ctx)

Extract the Credentials from a WebContext and return Optional.empty() if no credentials are present or throw a CredentialsException if it cannot get it.

Specified by:

extract in interface CredentialsExtractor

Parameters:

ctx - the current context

Returns:

the credentials (optional)