FormExtractor (pac4j core 5.4.5 API)

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

All Implemented Interfaces:

CredentialsExtractor
```
public class FormExtractor
extends java.lang.Object
implements CredentialsExtractor
```
To extract a username and password posted from a form.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors
Constructor Description

FormExtractor(java.lang.String usernameParameter, java.lang.String passwordParameter)

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`	`getPasswordParameter()`
`java.lang.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(java.lang.String usernameParameter,
                     java.lang.String passwordParameter)
```
- 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)
  - getUsernameParameter
```
public java.lang.String getUsernameParameter()
```
  - getPasswordParameter
```
public java.lang.String getPasswordParameter()
```