Package io.micronaut.security.endpoints

Class LogoutControllerConfigurationProperties

java.lang.Object

io.micronaut.security.endpoints.LogoutControllerConfigurationProperties

All Implemented Interfaces:

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

@Requires(property="micronaut.security.endpoints.logout.enabled",
          notEquals="false",
          defaultValue="true")
@ConfigurationProperties("micronaut.security.endpoints.logout")
public class LogoutControllerConfigurationProperties
extends Object
implements LogoutControllerConfiguration

Implementation of LogoutControllerConfiguration used to configure the LogoutController.

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
LogoutControllerConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
@NonNull String	getPath()
boolean	isEnabled()
boolean	isGetAllowed()
void	setEnabled(boolean enabled)	Enables LogoutController.
void	setGetAllowed(boolean getAllowed)	Enables HTTP GET invocations of LogoutController.
void	setPath(String path)	Path to the LogoutController.

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

LogoutControllerConfigurationProperties

public LogoutControllerConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Specified by:

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

Returns:

true if you want to enable the LogoutController

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)

Enables LogoutController. Default value true.

Parameters:

enabled - true if it is

setPath

public void setPath(String path)

Path to the LogoutController. Default value "/logout".

Parameters:

path - The path

isGetAllowed

public boolean isGetAllowed()

Specified by:

isGetAllowed in interface LogoutControllerConfiguration

Returns:

true if you want to support HTTP GET invocations in the LogoutController.

setGetAllowed

public void setGetAllowed(boolean getAllowed)

Enables HTTP GET invocations of LogoutController. Default value (false).

Parameters:

getAllowed - Whether Http GET should be supported.