org.pac4j.core.credentials.extractor

Class FormExtractor

java.lang.Object

org.pac4j.core.credentials.extractor.FormExtractor

All Implemented Interfaces:

CredentialsExtractor<UsernamePasswordCredentials>

public class FormExtractor
extends java.lang.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 and Description
FormExtractor(java.lang.String usernameParameter, java.lang.String passwordParameter, java.lang.String clientName)

Method Summary

Modifier and Type	Method and Description
UsernamePasswordCredentials	extract(WebContext context) Extract the right credentials.
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,
                     java.lang.String clientName)

Method Detail

extract

public UsernamePasswordCredentials extract(WebContext context)
                                    throws HttpAction

Description copied from interface: CredentialsExtractor

Extract the right credentials. It should throw a CredentialsException in case of failure.

Specified by:

extract in interface CredentialsExtractor<UsernamePasswordCredentials>

Parameters:

context - the current web context

Returns:

the credentials

Throws:

HttpAction - requires a specific HTTP action if necessary

getUsernameParameter

public java.lang.String getUsernameParameter()

getPasswordParameter

public java.lang.String getPasswordParameter()