io.micronaut.security.token.config

Class TokenConfigurationProperties

java.lang.Object

io.micronaut.security.token.config.TokenConfigurationProperties

All Implemented Interfaces:

Toggleable, TokenConfiguration

@ConfigurationProperties(value="micronaut.security.token")
public class TokenConfigurationProperties
extends Object
implements TokenConfiguration

Defines Security Token Configuration.

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	DEFAULT_ROLES_NAME Deprecated. Use TokenConfiguration.DEFAULT_ROLES_NAME instead
static String	PREFIX

Constructor Summary

Constructors

Constructor and Description
TokenConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
String	getRolesName() The name in the claims object that stores the granted roles.
boolean	isEnabled()
void	setEnabled(boolean enabled) Sets whether the configuration is enabled.
void	setRolesName(String rolesName) Name of the roles property.

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

DEFAULT_ROLES_NAME

@Deprecated
public static final String DEFAULT_ROLES_NAME

Deprecated. Use TokenConfiguration.DEFAULT_ROLES_NAME instead

The default roles name.

See Also:

Constant Field Values

Constructor Detail

TokenConfigurationProperties

public TokenConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Whether the component is enabled

getRolesName

public String getRolesName()

Description copied from interface: TokenConfiguration

The name in the claims object that stores the granted roles.

Specified by:

getRolesName in interface TokenConfiguration

Returns:

The roles claim name, e.g. roles.

See Also:

(). If not specified, defaults to {@link #DEFAULT_ROLES_NAME}.

setEnabled

public void setEnabled(boolean enabled)

Sets whether the configuration is enabled. Default value true.

Parameters:

enabled - True if it is enabled

setRolesName

public void setRolesName(String rolesName)

Name of the roles property. Default value "roles".

Parameters:

rolesName - The roles name