Module io.inverno.mod.security.http

Package io.inverno.mod.security.http.token

Class CookieTokenCredentialsExtractor

java.lang.Object

io.inverno.mod.security.http.token.CookieTokenCredentialsExtractor

All Implemented Interfaces:

CredentialsExtractor<TokenCredentials>

public class CookieTokenCredentialsExtractor
extends Object
implements CredentialsExtractor<TokenCredentials>

A credentials extractor that extracts a token credentials stored in an HTTP cookie.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_COOKIE_NAME	The default token cookie name: AUTH-TOKEN.

Constructor Summary

Constructors

Constructor	Description
CookieTokenCredentialsExtractor()	Creates a cookie token credentials extractor with the default token cookie name.
CookieTokenCredentialsExtractor(String tokenCookie)	Creates a cookie token credentials extractor with the specified token cookie name.

Method Summary

Modifier and Type	Method	Description
Mono<TokenCredentials>	extract(Exchange<?> exchange)	Extracts credentials from the specified exchange.
String	getTokenCookie()	Returns the token credentials cookie 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_COOKIE_NAME

public static final String DEFAULT_COOKIE_NAME

The default token cookie name: AUTH-TOKEN.

This constant is also used in CookieTokenLoginSuccessHandler and CookieTokenLogoutSuccessHandler.

See Also:

• Constant Field Values

Constructor Details

CookieTokenCredentialsExtractor

public CookieTokenCredentialsExtractor()

Creates a cookie token credentials extractor with the default token cookie name.

CookieTokenCredentialsExtractor

public CookieTokenCredentialsExtractor(String tokenCookie)

Creates a cookie token credentials extractor with the specified token cookie name.

Parameters:

tokenCookie - the token cookie name

Method Details

getTokenCookie

public String getTokenCookie()

Returns the token credentials cookie name.

Returns:

the token cookie name

extract

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

Description copied from interface: CredentialsExtractor

Extracts credentials from the specified exchange.

Specified by:

extract in interface CredentialsExtractor<TokenCredentials>

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