Package io.micronaut.security.token.bearer

Class BearerTokenConfigurationProperties

java.lang.Object

io.micronaut.security.token.bearer.BearerTokenConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, BearerTokenConfiguration

@Requires(property="micronaut.security.token.bearer.enabled",
          notEquals="false")
@ConfigurationProperties("micronaut.security.token.bearer")
public class BearerTokenConfigurationProperties
extends Object
implements BearerTokenConfiguration

Default implementation of BearerTokenConfiguration.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLED
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
BearerTokenConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
String	getHeaderName()
String	getPrefix()
boolean	isEnabled()
void	setEnabled(boolean enabled)	Set whether to enable bearer token authentication.
void	setHeaderName(String headerName)	Sets the header name to use.
void	setPrefix(String headerPrefix)	Sets the prefix to use for the auth token.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

• Constant Field Values

Constructor Details

BearerTokenConfigurationProperties

public BearerTokenConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface BearerTokenConfiguration

Specified by:

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

Returns:

a boolean flag indicating whether BearerTokenReader bean should be enabled or not

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface BearerTokenConfiguration

Returns:

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

getHeaderName

public String getHeaderName()

Specified by:

getHeaderName in interface BearerTokenConfiguration

Returns:

an HTTP Header name. e.g. Authorization

setEnabled

public void setEnabled(boolean enabled)

Set whether to enable bearer token authentication. Default value true.

Parameters:

enabled - True if enabled

setHeaderName

public void setHeaderName(String headerName)

Sets the header name to use. Default value Authorization.

Parameters:

headerName - The header name to use

setPrefix

public void setPrefix(String headerPrefix)

Sets the prefix to use for the auth token. Default value Bearer.

Parameters:

headerPrefix - The prefix to use