Package io.micronaut.security.token.writer

Class HttpHeaderTokenWriterConfigurationProperties

java.lang.Object

io.micronaut.security.token.writer.HttpHeaderTokenWriterConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable

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

HTTP Token Writer Configuration Properties.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
HttpHeaderTokenWriterConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHeaderName()
java.lang.String	getPrefix()
boolean	isEnabled()
void	setEnabled(boolean enabled)	Enable HttpHeaderTokenWriter.
void	setHeaderName(java.lang.String headerName)	Http Header to be used to propagate the token.
void	setPrefix(java.lang.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 java.lang.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()

Specified by:

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

setEnabled

public void setEnabled(boolean enabled)

Enable HttpHeaderTokenWriter. Default value (true).

Parameters:

enabled - enabled flag

setPrefix

public void setPrefix(java.lang.String prefix)

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

Parameters:

prefix - preffix before the header value

getPrefix

public java.lang.String getPrefix()

Returns:

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

setHeaderName

public void setHeaderName(java.lang.String headerName)

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

Parameters:

headerName - HTTP header name

getHeaderName

public java.lang.String getHeaderName()

Returns:

an HTTP Header name. e.g. Authorization