io.micronaut.security.oauth2.configuration

Class OauthConfigurationProperties

java.lang.Object

io.micronaut.security.oauth2.configuration.OauthConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, OauthConfiguration

@Requires(property="micronaut.security.oauth2.enabled",value="true",defaultValue="true") @Requires(property="micronaut.security.oauth2.client-id")
 @ConfigurationProperties(value="micronaut.security.oauth2")
public class OauthConfigurationProperties
extends java.lang.Object
implements OauthConfiguration

ConfigurationProperties implementation of OauthConfiguration.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enable value.
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
OauthConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientId()
java.lang.String	getClientSecret()
boolean	isEnabled()
void	setClientId(java.lang.String clientId) OAuth 2.0 Application Client ID.
void	setClientSecret(java.lang.String clientSecret) OAuth 2.0 Application Client Secret.
void	setEnabled(boolean enabled) Sets whether the OauthConfiguration is enabled.

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

OauthConfigurationProperties

public OauthConfigurationProperties()

Method Detail

setClientId

public void setClientId(@Nonnull
                        java.lang.String clientId)

OAuth 2.0 Application Client ID.

Parameters:

clientId - The application's Client ID.

setClientSecret

public void setClientSecret(@Nullable
                            java.lang.String clientSecret)

OAuth 2.0 Application Client Secret. Optional.

Parameters:

clientSecret - The application's Client Secret.

getClientId

@Nonnull
public java.lang.String getClientId()

Specified by:

getClientId in interface OauthConfiguration

Returns:

the application's Client identifier

getClientSecret

@Nullable
public java.lang.String getClientSecret()

Specified by:

getClientSecret in interface OauthConfiguration

Returns:

the application's Client secret

isEnabled

public boolean isEnabled()

Specified by:

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

Returns:

true if you want to enable the OauthConfiguration

setEnabled

public void setEnabled(boolean enabled)

Sets whether the OauthConfiguration is enabled. Default value (true).

Parameters:

enabled - True if is enabled