FormExtractor (pac4j core 4.0.0-RC2 API)

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

All Implemented Interfaces:

CredentialsExtractor<UsernamePasswordCredentials>
```
public class FormExtractor
extends Object
implements CredentialsExtractor<UsernamePasswordCredentials>
```
To extract a username and password posted from a form.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors
Constructor Description

FormExtractor(String usernameParameter, String passwordParameter)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Optional<UsernamePasswordCredentials>`	`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`	`getPasswordParameter()`
`String`	`getUsernameParameter()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FormExtractor
```
public FormExtractor(String usernameParameter,
                     String passwordParameter)
```
- Method Detail
  - extract
```
public Optional<UsernamePasswordCredentials> 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<UsernamePasswordCredentials>
    
    Parameters:
    
    context - the current web context
    
    Returns:
    
    the credentials (optional)
  - getUsernameParameter
```
public String getUsernameParameter()
```
  - getPasswordParameter
```
public String getPasswordParameter()
```