Package org.pac4j.core.credentials.extractor

Class FormExtractor

java.lang.Object

org.pac4j.core.credentials.extractor.FormExtractor

All Implemented Interfaces:

CredentialsExtractor

public class FormExtractor
extends Object
implements CredentialsExtractor

To extract a username and password posted from a form.

Since:

1.8.0

Author:

Jerome Leleu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FormExtractor.ExtractionMode

Constructor Summary

Constructors

Constructor	Description
FormExtractor()

Method Summary

Modifier and Type	Method	Description
Optional<Credentials>	extract(CallContext ctx)	Extract the Credentials from a WebContext and return Optional.empty() if no credentials are present or throw a CredentialsException if it cannot get it.

Methods inherited from class java.lang.Object

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

Constructor Details

FormExtractor

public FormExtractor()

Method Details

extract

public Optional<Credentials> extract(CallContext ctx)

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:

ctx - the current context

Returns:

the credentials (optional)