io.micronaut.security.oauth2.endpoints

Class AuthorizationCodeControllerConfigurationProperties

java.lang.Object

io.micronaut.security.oauth2.endpoints.AuthorizationCodeControllerConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, AuthorizationCodeControllerConfiguration

@ConfigurationProperties(value="micronaut.security.endpoints.authcode")
public class AuthorizationCodeControllerConfigurationProperties
extends java.lang.Object
implements AuthorizationCodeControllerConfiguration

ConfigurationProperties implementation of AuthorizationCodeControllerConfiguration.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CALLBACK The default callback path.
static java.lang.String	DEFAULT_CONTROLLERPATH The default path.
static boolean	DEFAULT_ENABLED The default enable value.
static java.lang.String	DEFAULT_LOGIN The default login path.
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
AuthorizationCodeControllerConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCallbackPath() The path to respond to callbacks.
java.lang.String	getControllerPath() The base path the authorization controller responds to.
java.lang.String	getLoginPath() The path to listen for login requests.
boolean	isEnabled()
void	setCallbackPath(java.lang.String callbackPath) Sets the path used by OAuth providers to callback the application.
void	setControllerPath(java.lang.String controllerPath) The authorization controller path.
void	setEnabled(boolean enabled) Sets whether the AuthorizationCodeController is enabled.
void	setLoginPath(java.lang.String loginPath) Sets the path used to trigger a redirect to login with OAuth.

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

DEFAULT_CONTROLLERPATH

public static final java.lang.String DEFAULT_CONTROLLERPATH

The default path.

See Also:

Constant Field Values

DEFAULT_CALLBACK

public static final java.lang.String DEFAULT_CALLBACK

The default callback path.

See Also:

Constant Field Values

DEFAULT_LOGIN

public static final java.lang.String DEFAULT_LOGIN

The default login path.

See Also:

Constant Field Values

Constructor Detail

AuthorizationCodeControllerConfigurationProperties

public AuthorizationCodeControllerConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

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

Returns:

true if you want to enable the AuthorizationCodeController

setEnabled

public void setEnabled(boolean enabled)

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

Parameters:

enabled - True if is enabled

getControllerPath

@Nonnull
public java.lang.String getControllerPath()

Description copied from interface: AuthorizationCodeControllerConfiguration

The base path the authorization controller responds to.

Specified by:

getControllerPath in interface AuthorizationCodeControllerConfiguration

Returns:

The controller path

getCallbackPath

@Nonnull
public java.lang.String getCallbackPath()

Description copied from interface: AuthorizationCodeControllerConfiguration

The path to respond to callbacks. Appended to the controller path.

Specified by:

getCallbackPath in interface AuthorizationCodeControllerConfiguration

Returns:

The controller's callback path

getLoginPath

@Nonnull
public java.lang.String getLoginPath()

Description copied from interface: AuthorizationCodeControllerConfiguration

The path to listen for login requests. Appended to the controller path.

Specified by:

getLoginPath in interface AuthorizationCodeControllerConfiguration

Returns:

The controller's login path

setControllerPath

public void setControllerPath(@Nonnull
                              java.lang.String controllerPath)

The authorization controller path. Default value ("/authcode").

Parameters:

controllerPath - Controller's path

setCallbackPath

public void setCallbackPath(@Nonnull
                            java.lang.String callbackPath)

Sets the path used by OAuth providers to callback the application. The value is appended to the controller path value. Default value ("/cb").

Parameters:

callbackPath - Controller callback path.

setLoginPath

public void setLoginPath(@Nonnull
                         java.lang.String loginPath)

Sets the path used to trigger a redirect to login with OAuth. The value is appended to the controller path value. Default value ("/login").

Parameters:

loginPath - Controller login path.