io.micronaut.security.token.config

Interface TokenConfiguration

All Superinterfaces:

io.micronaut.core.util.Toggleable

All Known Implementing Classes:

TokenConfigurationProperties

public interface TokenConfiguration
extends io.micronaut.core.util.Toggleable

Defines Security Token Configuration.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NAME_KEY
static java.lang.String	DEFAULT_ROLES_NAME
static java.lang.String	DEFAULT_ROLES_SEPARATOR

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getNameKey() Key which will be used in the Authentication.getAttributes() for the User`s name.
default java.lang.String	getRolesName() Key which will be used in the Authentication.getAttributes() for the User`s roles.
default java.lang.String	getRolesSeparator() Separator which will be used for splitting the roles before processing the Authentication.

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Field Detail

DEFAULT_ROLES_NAME

static final java.lang.String DEFAULT_ROLES_NAME

See Also:

Constant Field Values

DEFAULT_NAME_KEY

static final java.lang.String DEFAULT_NAME_KEY

See Also:

Constant Field Values

DEFAULT_ROLES_SEPARATOR

static final java.lang.String DEFAULT_ROLES_SEPARATOR

Method Detail

getRolesName

@NonNull
default java.lang.String getRolesName()

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

Returns:

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

getNameKey

@NonNull
default java.lang.String getNameKey()

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

Returns:

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

getRolesSeparator

@Nullable
default java.lang.String getRolesSeparator()

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

Returns:

The separator used for splitting the users roles