Module io.inverno.mod.security.http

Package io.inverno.mod.security.http.form

Class FormCredentialsExtractor

java.lang.Object

io.inverno.mod.security.http.form.FormCredentialsExtractor

All Implemented Interfaces:

CredentialsExtractor<LoginCredentials>

public class FormCredentialsExtractor
extends Object
implements CredentialsExtractor<LoginCredentials>

A credentials extractor that extracts login credentials provided by a user in a form (application/x-www-form-urlencoded) submitted in an HTTP POST request.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PARAMETER_PASSWORD	The default password parameter name.
static final String	DEFAULT_PARAMETER_USERNAME	The default username parameter name.

Constructor Summary

Constructors

Constructor	Description
FormCredentialsExtractor()	Creates a form credentials extractor with default username and password parameter names.
FormCredentialsExtractor(String usernameParameter, String passwordParameter)	Creates a form credentials extractor with specified username and password parameter names.

Method Summary

Modifier and Type	Method	Description
Mono<LoginCredentials>	extract(Exchange<?> exchange)	Extracts credentials from the specified exchange.
String	getPasswordParameter()	Returns the password parameter name.
String	getUsernameParameter()	Returns the username parameter name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.security.http.CredentialsExtractor

or

Field Details

DEFAULT_PARAMETER_USERNAME

public static final String DEFAULT_PARAMETER_USERNAME

The default username parameter name.

See Also:

• Constant Field Values

DEFAULT_PARAMETER_PASSWORD

public static final String DEFAULT_PARAMETER_PASSWORD

The default password parameter name.

See Also:

• Constant Field Values

Constructor Details

FormCredentialsExtractor

public FormCredentialsExtractor()

Creates a form credentials extractor with default username and password parameter names.

FormCredentialsExtractor

public FormCredentialsExtractor(String usernameParameter,
 String passwordParameter)

Creates a form credentials extractor with specified username and password parameter names.

Parameters:

usernameParameter - the username parameter name

passwordParameter - the password parameter name

Method Details

getUsernameParameter

public String getUsernameParameter()

Returns the username parameter name.

Returns:

the username parameter name

getPasswordParameter

public String getPasswordParameter()

Returns the password parameter name.

Returns:

the password parameter name

extract

public Mono<LoginCredentials> extract(Exchange<?> exchange)
                               throws MalformedCredentialsException

Description copied from interface: CredentialsExtractor

Extracts credentials from the specified exchange.

Specified by:

extract in interface CredentialsExtractor<LoginCredentials>

Parameters:

exchange - the exchange

Returns:

a mono emitting the credentials or an empty mono if the exchange didn't provide any credentials

Throws:

MalformedCredentialsException - if credentials in the exchange are malformed