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)
ParameterExtractor(String parameterName, boolean supportGetRequest, boolean supportPostRequest)

Method Summary

Modifier and Type	Method	Description
Optional<Credentials>	extract(WebContext context, SessionStore sessionStore)	Extract the Credentials from a WebContext and return Optional.empty() if no credentials are present or throw a CredentialsException if it cannot get it.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterExtractor

public ParameterExtractor(String parameterName)

ParameterExtractor

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

Method Details

extract

public Optional<Credentials> extract(WebContext context,
 SessionStore sessionStore)

Description copied from interface: CredentialsExtractor

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:

context - the current web context

sessionStore - the session store

Returns:

the credentials (optional)

toString

public String toString()

Overrides:

toString in class Object