Package io.micronaut.security.endpoints

Class OauthControllerConfigurationProperties

java.lang.Object

io.micronaut.security.endpoints.OauthControllerConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, ControllerConfiguration, OauthControllerConfiguration

@Requires(property="micronaut.security.endpoints.oauth.enabled",
          notEquals="false",
          defaultValue="true")
@ConfigurationProperties("micronaut.security.endpoints.oauth")
public class OauthControllerConfigurationProperties
extends Object
implements OauthControllerConfiguration

Configures the provided OauthController.

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 boolean	DEFAULT_GETALLOWED	Default Get Allowed.
static final String	DEFAULT_PATH	The default path.
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
OauthControllerConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
@NonNull String	getPath()
boolean	isEnabled()
boolean	isGetAllowed()
void	setEnabled(boolean enabled)	Sets whether the OauthController is enabled.
void	setGetAllowed(boolean getAllowed)	Enables HTTP GET invocations of refresh token requests.
void	setPath(String path)	Sets the path to map the OauthController to.

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

DEFAULT_PATH

public static final String DEFAULT_PATH

The default path.

See Also:

• Constant Field Values

DEFAULT_GETALLOWED

public static final boolean DEFAULT_GETALLOWED

Default Get Allowed.

See Also:

• Constant Field Values

Constructor Details

OauthControllerConfigurationProperties

public OauthControllerConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Specified by:

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

Returns:

true if you want to enable the OauthController

getPath

@NonNull
public @NonNull String getPath()

Specified by:

getPath in interface ControllerConfiguration

Returns:

the path where the controller is enabled.

setEnabled

public void setEnabled(boolean enabled)

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

Parameters:

enabled - True if is enabled

setPath

public void setPath(String path)

Sets the path to map the OauthController to. Default value ("/oauth/access_token").

Parameters:

path - The path

isGetAllowed

public boolean isGetAllowed()

Specified by:

isGetAllowed in interface OauthControllerConfiguration

Returns:

True if refresh requests can be GET

setGetAllowed

public void setGetAllowed(boolean getAllowed)

Enables HTTP GET invocations of refresh token requests. Only applies to requests sending a cookie (JWT_REFRESH_TOKEN). Default value (true).

Parameters:

getAllowed - Whether Http GET should be supported.