Package io.micronaut.security.token.basicauth

Class BasicAuthTokenReaderConfigurationProperties

java.lang.Object

io.micronaut.security.token.basicauth.BasicAuthTokenReaderConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, BasicAuthTokenReaderConfiguration

@Requires(property="micronaut.security.token.enabled",
          notEquals="false")
@ConfigurationProperties("micronaut.security.token.basic-auth")
public class BasicAuthTokenReaderConfigurationProperties
extends java.lang.Object
implements BasicAuthTokenReaderConfiguration

Default implementation of BasicAuthTokenReaderConfiguration.

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHeaderName()
java.lang.String	getPrefix()
boolean	isEnabled()
void	setEnabled(boolean enabled)	Enables BasicAuthTokenReader.
void	setHeaderName(java.lang.String headerName)	Http Header name.
void	setPrefix(java.lang.String prefix)	Http Header value prefix.

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

BasicAuthTokenReaderConfigurationProperties

public BasicAuthTokenReaderConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface BasicAuthTokenReaderConfiguration

Specified by:

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

Returns:

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

getPrefix

public java.lang.String getPrefix()

Specified by:

getPrefix in interface BasicAuthTokenReaderConfiguration

Returns:

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

getHeaderName

public java.lang.String getHeaderName()

Specified by:

getHeaderName in interface BasicAuthTokenReaderConfiguration

Returns:

an HTTP Header name. e.g. Authorization

setEnabled

public void setEnabled(boolean enabled)

Enables BasicAuthTokenReader. Default value true.

Parameters:

enabled - True if enabled

setHeaderName

public void setHeaderName(java.lang.String headerName)

Http Header name. Default value "Authorization".

Parameters:

headerName - The header name to use

setPrefix

public void setPrefix(java.lang.String prefix)

Http Header value prefix. Default value "Basic".

Parameters:

prefix - The prefix to use