Class OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties.HeaderTokenPropagatorConfigurationProperties

java.lang.Object

io.micronaut.security.oauth2.configuration.OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties.HeaderTokenPropagatorConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, ClientCredentialsHeaderTokenPropagatorConfiguration

Enclosing class:

OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties

@ConfigurationProperties("header-propagation")
@Requires(classes=io.micronaut.http.util.OutgoingRequestProcessorMatcher.class)
public static class OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties.HeaderTokenPropagatorConfigurationProperties
extends Object
implements ClientCredentialsHeaderTokenPropagatorConfiguration

Client credentials http header token propagation configuration.

Since:

1.2.0

Author:

James Kleeh

Field Summary

Fields inherited from interface ClientCredentialsHeaderTokenPropagatorConfiguration

DEFAULT_ENABLED, DEFAULT_HEADER_NAME, DEFAULT_PREFIX

Constructor Summary

Constructors

Constructor	Description
HeaderTokenPropagatorConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
String	getHeaderName()
String	getPrefix()
boolean	isEnabled()
void	setEnabled(boolean enabled)	Enable ClientCredentialsHeaderTokenPropagatorConfiguration.
void	setHeaderName(String headerName)	Http Header to be used to propagate the token.
void	setPrefix(String prefix)	Value prefix for Http Header.

Methods inherited from class Object

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

Constructor Details

HeaderTokenPropagatorConfigurationProperties

public HeaderTokenPropagatorConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

setEnabled

public void setEnabled(boolean enabled)

Enable ClientCredentialsHeaderTokenPropagatorConfiguration. Default value (true).

Parameters:

enabled - enabled flag

setPrefix

public void setPrefix(String prefix)

Value prefix for Http Header. Default value ("Bearer").

Parameters:

prefix - preffix before the header value

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface ClientCredentialsHeaderTokenPropagatorConfiguration

Returns:

a Prefix before the token in the header value. E.g. Bearer

setHeaderName

public void setHeaderName(String headerName)

Http Header to be used to propagate the token. Default value ("Authorization")

Parameters:

headerName - HTTP header name

getHeaderName

public String getHeaderName()

Specified by:

getHeaderName in interface ClientCredentialsHeaderTokenPropagatorConfiguration

Returns:

an HTTP Header name. e.g. Authorization