Package io.micronaut.security.oauth2.client.clientcredentials.propagation

Class ClientCredentialsHeaderTokenPropagator

java.lang.Object

io.micronaut.security.oauth2.client.clientcredentials.propagation.ClientCredentialsHeaderTokenPropagator

All Implemented Interfaces:

io.micronaut.core.order.Ordered, ClientCredentialsTokenPropagator

Direct Known Subclasses:

DefaultClientCredentialsTokenPropagator

@Internal
@EachBean(OauthClientConfiguration.class)
@Requires(condition=ClientCredentialsEnabled.class) @Requires(condition=ClientCredentialsHeaderPropagatorEnabled.class)
public class ClientCredentialsHeaderTokenPropagator
extends java.lang.Object
implements ClientCredentialsTokenPropagator

Propagates a token obtained via client credentials based off of a header.

Since:

2.2.0

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientCredentialsHeaderTokenPropagatorConfiguration	configuration
static java.lang.String	SPACE

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
ClientCredentialsHeaderTokenPropagator(ClientCredentialsHeaderTokenPropagatorConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
protected java.util.Optional<java.lang.String>	extractTokenFromAuthorization(java.lang.String authorization)
java.util.Optional<java.lang.String>	findToken(io.micronaut.http.HttpRequest<?> request)	Search for a JWT token in a HTTP request.
ClientCredentialsHeaderTokenPropagatorConfiguration	getConfiguration()
protected java.lang.String	headerValue(java.lang.String token)
void	writeToken(io.micronaut.http.MutableHttpRequest<?> request, java.lang.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 Detail

SPACE

public static final java.lang.String SPACE

See Also:

Constant Field Values

configuration

protected final ClientCredentialsHeaderTokenPropagatorConfiguration configuration

Constructor Detail

ClientCredentialsHeaderTokenPropagator

public ClientCredentialsHeaderTokenPropagator(ClientCredentialsHeaderTokenPropagatorConfiguration configuration)

Parameters:

configuration - The token propagator configuration

Method Detail

writeToken

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

Writes the token to the request.

Specified by:

writeToken in interface ClientCredentialsTokenPropagator

Parameters:

request - The MutableHttpRequest instance

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

findToken

public java.util.Optional<java.lang.String> findToken(@NonNull
                                                      io.micronaut.http.HttpRequest<?> request)

Search for a JWT token in a HTTP request.

Specified by:

findToken in interface ClientCredentialsTokenPropagator

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 java.lang.String headerValue(java.lang.String token)

Parameters:

token - the token being written

Returns:

the value which will be written to an HTTP Header

extractTokenFromAuthorization

protected java.util.Optional<java.lang.String> extractTokenFromAuthorization(java.lang.String authorization)

Parameters:

authorization - Authorization header value

Returns:

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

getConfiguration

public ClientCredentialsHeaderTokenPropagatorConfiguration getConfiguration()

Returns:

The HttpHeaderTokenPropagator Configuration