Package io.micronaut.security.token.propagation

Class HttpHeaderTokenPropagator

java.lang.Object

io.micronaut.security.token.propagation.HttpHeaderTokenPropagator

All Implemented Interfaces:

io.micronaut.core.order.Ordered, TokenPropagator

@Requires(property="micronaut.security.token.propagation.header.enabled",
          notEquals="false")
@Singleton
public class HttpHeaderTokenPropagator
extends Object
implements TokenPropagator

Propagates a token based off of a header.

Since:

1.4.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field	Description
protected final HttpHeaderTokenPropagatorConfiguration	configuration

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
HttpHeaderTokenPropagator(HttpHeaderTokenPropagatorConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
protected Optional<String>	extractTokenFromAuthorization(String authorization)
Optional<String>	findToken(io.micronaut.http.HttpRequest<?> request)	Search for a JWT token in a HTTP request.
HttpHeaderTokenPropagatorConfiguration	getConfiguration()
protected String	headerValue(String token)
void	writeToken(io.micronaut.http.MutableHttpRequest<?> request, String token)	Writes the token to the request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Field Details

configuration

protected final HttpHeaderTokenPropagatorConfiguration configuration

Constructor Details

HttpHeaderTokenPropagator

public HttpHeaderTokenPropagator(HttpHeaderTokenPropagatorConfiguration configuration)

Parameters:

configuration - The token propagator configuration

Method Details

writeToken

public void writeToken(io.micronaut.http.MutableHttpRequest<?> request,
 String token)

Writes the token to the request.

Specified by:

writeToken in interface TokenPropagator

Parameters:

request - The MutableHttpRequest instance

token - A token ( e.g. JWT token, basic auth token...)

findToken

public Optional<String> findToken(io.micronaut.http.HttpRequest<?> request)

Search for a JWT token in a HTTP request.

Specified by:

findToken in interface TokenPropagator

Parameters:

request - The request to look for the token in

Returns:

if the JWT token is found it is returned, empty if not

headerValue

protected String headerValue(String token)

Parameters:

token - the token being written

Returns:

the value which will be written to an HTTP Header

extractTokenFromAuthorization

protected Optional<String> extractTokenFromAuthorization(String authorization)

Parameters:

authorization - Authorization header value

Returns:

If prefix is 'Bearer' for 'Bearer XXX' it returns 'XXX'

getConfiguration

public HttpHeaderTokenPropagatorConfiguration getConfiguration()

Returns:

The HttpHeaderTokenPropagator Configuration