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")
 @ConfigurationProperties(value="micronaut.security.oauth2")
public class OauthConfigurationProperties
extends java.lang.Object
implements OauthConfiguration

ConfigurationProperties implementation of OauthClientConfiguration.

Since:

1.2.0

Author:

Sergio del Amo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OauthConfigurationProperties.OpenIdConfigurationProperties OpenID configuration

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	getCallbackUri()
java.util.Optional<java.lang.String>	getDefaultProvider()
java.lang.String	getLoginUri()
OpenIdConfiguration	getOpenid()
boolean	isEnabled()
void	setCallbackUri(java.lang.String callbackUri) The URI template that OAuth 2.0 providers can use to submit an authorization callback request.
void	setDefaultProvider(java.lang.String defaultProvider) The default authentication provider for an OAuth 2.0 authorization code grant flow.
void	setEnabled(boolean enabled) Sets whether the OAuth 2.0 support is enabled.
void	setLoginUri(java.lang.String loginUri) The URI template that is used to initiate an OAuth 2.0 authorization code grant flow.
void	setOpenid(OauthConfigurationProperties.OpenIdConfigurationProperties openid) The OpenID configuration

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

isEnabled

public boolean isEnabled()

Specified by:

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

setEnabled

public void setEnabled(boolean enabled)

Sets whether the OAuth 2.0 support is enabled. Default value (false).

Parameters:

enabled - True if is enabled

getLoginUri

@Nonnull
public java.lang.String getLoginUri()

Specified by:

getLoginUri in interface OauthConfiguration

Returns:

the login Uri

setLoginUri

public void setLoginUri(@Nonnull
                        java.lang.String loginUri)

The URI template that is used to initiate an OAuth 2.0 authorization code grant flow. Default value ().

Parameters:

loginUri - The Login uri

getCallbackUri

@Nonnull
public java.lang.String getCallbackUri()

Specified by:

getCallbackUri in interface OauthConfiguration

Returns:

the Callback Uri

setDefaultProvider

public void setDefaultProvider(java.lang.String defaultProvider)

The default authentication provider for an OAuth 2.0 authorization code grant flow.

Parameters:

defaultProvider - The default authentication provider

getDefaultProvider

@Nullable
public java.util.Optional<java.lang.String> getDefaultProvider()

Specified by:

getDefaultProvider in interface OauthConfiguration

Returns:

the default authorization provider

setCallbackUri

public void setCallbackUri(@Nonnull
                           java.lang.String callbackUri)

The URI template that OAuth 2.0 providers can use to submit an authorization callback request. Default value ().

Parameters:

callbackUri - The callback Uri

getOpenid

@Nonnull
public OpenIdConfiguration getOpenid()

Specified by:

getOpenid in interface OauthConfiguration

Returns:

OpenID Connect Configuration

setOpenid

public void setOpenid(@Nonnull
                      OauthConfigurationProperties.OpenIdConfigurationProperties openid)

The OpenID configuration

Parameters:

openid - The OpenID configuration