ParameterExtractor (pac4j core 5.4.5 API)

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

All Implemented Interfaces:

CredentialsExtractor
```
public class ParameterExtractor
extends java.lang.Object
implements CredentialsExtractor
```
To extract a parameter value.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors
Constructor	Description
`ParameterExtractor(java.lang.String parameterName)`
`ParameterExtractor(java.lang.String parameterName, boolean supportGetRequest, boolean supportPostRequest)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.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.
`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)
```
  - ParameterExtractor
```
public ParameterExtractor(java.lang.String parameterName,
                          boolean supportGetRequest,
                          boolean supportPostRequest)
```
- Method Detail
  - extract
```
public java.util.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 java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object