Package io.micronaut.security.token.config

Class TokenConfigurationProperties

java.lang.Object

io.micronaut.security.token.config.TokenConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, TokenConfiguration

@ConfigurationProperties("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	Description
static final boolean	DEFAULT_ENABLED	The default enable value.
static final String	PREFIX

Fields inherited from interface io.micronaut.security.token.config.TokenConfiguration

DEFAULT_NAME_KEY, DEFAULT_ROLES_NAME, DEFAULT_ROLES_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
TokenConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
@NonNull String	getNameKey()	Key which will be used in the Authentication.getAttributes() for the User`s name.
@NonNull String	getRolesName()	Key which will be used in the Authentication.getAttributes() for the User`s roles.
@Nullable String	getRolesSeparator()	Separator which will be used for splitting the roles before processing the Authentication.
boolean	isEnabled()
void	setEnabled(boolean enabled)	Sets whether the configuration is enabled.
void	setNameKey(@NonNull String nameKey)	Authentication attributes map key for the user's name.
void	setRolesName(@NonNull String rolesName)	Authentication attributes map key for the user's roles.
void	setRolesSeparator(@Nullable String rolesSeparator)	If the entry used for the roles in the Authentication attributes map is a String, you can use the separator to split its value into multiple roles.

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

The default enable value.

See Also:

• Constant Field Values

Constructor Details

TokenConfigurationProperties

public TokenConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Specified by:

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

getRolesName

@NonNull
public @NonNull String getRolesName()

Description copied from interface: TokenConfiguration

Key which will be used in the Authentication.getAttributes() for the User`s roles.

Specified by:

getRolesName in interface TokenConfiguration

Returns:

The key used for the user's roles within the user's attributes. e.g. "roles".

See Also:

• (). If not specified, defaults to #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(@NonNull
 @NonNull String rolesName)

Authentication attributes map key for the user's roles. Default value "roles".

Parameters:

rolesName - The roles name

getNameKey

@NonNull
public @NonNull String getNameKey()

Description copied from interface: TokenConfiguration

Key which will be used in the Authentication.getAttributes() for the User`s name.

Specified by:

getNameKey in interface TokenConfiguration

Returns:

The key used for the user's name within the user's attributes. e.g. "sub".

See Also:

• If not specified, defaults to #DEFAULT_NAME_KEY.

setNameKey

public void setNameKey(@NonNull
 @NonNull String nameKey)

Authentication attributes map key for the user's name. Default value "sub".

Parameters:

nameKey - key for name

getRolesSeparator

@Nullable
public @Nullable String getRolesSeparator()

Description copied from interface: TokenConfiguration

Separator which will be used for splitting the roles before processing the Authentication.

Specified by:

getRolesSeparator in interface TokenConfiguration

Returns:

The separator used for splitting the users roles

setRolesSeparator

public void setRolesSeparator(@Nullable
 @Nullable String rolesSeparator)

If the entry used for the roles in the Authentication attributes map is a String, you can use the separator to split its value into multiple roles. Default value TokenConfiguration.DEFAULT_ROLES_SEPARATOR.

Parameters:

rolesSeparator - separator to split roles by