org.pac4j.core.credentials.extractor

Class ParameterExtractor

java.lang.Object

org.pac4j.core.credentials.extractor.ParameterExtractor

All Implemented Interfaces:

CredentialsExtractor<TokenCredentials>

public class ParameterExtractor
extends java.lang.Object
implements CredentialsExtractor<TokenCredentials>

To extract a parameter value.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
ParameterExtractor(java.lang.String parameterName, boolean supportGetRequest, boolean supportPostRequest, java.lang.String clientName)
ParameterExtractor(java.lang.String parameterName, java.lang.String clientName)

Method Summary

Modifier and Type	Method and Description
TokenCredentials	extract(WebContext context) Extract the right credentials.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterExtractor

public ParameterExtractor(java.lang.String parameterName,
                          java.lang.String clientName)

ParameterExtractor

public ParameterExtractor(java.lang.String parameterName,
                          boolean supportGetRequest,
                          boolean supportPostRequest,
                          java.lang.String clientName)

Method Detail

extract

public TokenCredentials extract(WebContext context)
                         throws HttpAction,
                                CredentialsException

Description copied from interface: CredentialsExtractor

Extract the right credentials. It should throw a CredentialsException in case of failure.

Specified by:

extract in interface CredentialsExtractor<TokenCredentials>

Parameters:

context - the current web context

Returns:

the credentials

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object