ParameterExtractor (pac4j core 4.0.0-RC2 API)

java.lang.Object
- org.pac4j.core.credentials.extractor.ParameterExtractor

All Implemented Interfaces:

CredentialsExtractor<TokenCredentials>
```
public class ParameterExtractor
extends Object
implements CredentialsExtractor<TokenCredentials>
```
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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Optional<TokenCredentials>`	`extract(WebContext context)`	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 Detail
  - ParameterExtractor
```
public ParameterExtractor(String parameterName)
```
  - ParameterExtractor
```
public ParameterExtractor(String parameterName,
                          boolean supportGetRequest,
                          boolean supportPostRequest)
```
- Method Detail
  - extract
```
public Optional<TokenCredentials> extract(WebContext context)
```
    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<TokenCredentials>
    
    Parameters:
    
    context - the current web context
    
    Returns:
    
    the credentials (optional)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object