io.micronaut.security.token.writer

Class HttpHeaderTokenWriterConfigurationProperties

java.lang.Object

io.micronaut.security.token.writer.HttpHeaderTokenWriterConfigurationProperties

@Requires(property="micronaut.security.token.writer.header.enabled",
          notEquals="false")
 @ConfigurationProperties(value="micronaut.security.token.writer.header")
public class HttpHeaderTokenWriterConfigurationProperties
extends Object

HTTP Token Writer Configuration Properties.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enable value.
static String	PREFIX

Constructor Summary

Constructors

Constructor and Description
HttpHeaderTokenWriterConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
String	getHeaderName()
String	getPrefix()
boolean	isEnabled()
void	setEnabled(boolean enabled) Enable HttpHeaderTokenWriter.
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 java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

Constructor Detail

HttpHeaderTokenWriterConfigurationProperties

public HttpHeaderTokenWriterConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Returns:

Whether the component is enabled

setEnabled

public void setEnabled(boolean enabled)

Enable HttpHeaderTokenWriter. 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()

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()

Returns:

an HTTP Header name. e.g. Authorization