Package io.micronaut.security.endpoints
Class LogoutControllerConfigurationProperties
- java.lang.Object
-
- io.micronaut.security.endpoints.LogoutControllerConfigurationProperties
-
- All Implemented Interfaces:
io.micronaut.core.util.Toggleable
,LogoutControllerConfiguration
@Requires(property="micronaut.security.endpoints.logout.enabled", value="true") @ConfigurationProperties("micronaut.security.endpoints.logout") public class LogoutControllerConfigurationProperties extends java.lang.Object implements LogoutControllerConfiguration
Implementation ofLogoutControllerConfiguration
used to configure theLogoutController
.- Since:
- 1.0
- Author:
- Sergio del Amo
-
-
Field Summary
Fields Modifier and Type Field Description static boolean
DEFAULT_ENABLED
The default enable value.static boolean
DEFAULT_GETALLOWED
Default Get Allowed.static java.lang.String
DEFAULT_PATH
The default path.static java.lang.String
PREFIX
-
Constructor Summary
Constructors Constructor Description LogoutControllerConfigurationProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getPath()
boolean
isEnabled()
boolean
isGetAllowed()
void
setEnabled(boolean enabled)
EnablesLogoutController
.void
setGetAllowed(boolean getAllowed)
Enables HTTP GET invocations ofLogoutController
.void
setPath(java.lang.String path)
Path to theLogoutController
.
-
-
-
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_PATH
public static final java.lang.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
-
-
Method Detail
-
isEnabled
public boolean isEnabled()
- Specified by:
isEnabled
in interfaceio.micronaut.core.util.Toggleable
- Returns:
- true if you want to enable the
LogoutController
-
getPath
public java.lang.String getPath()
- Specified by:
getPath
in interfaceLogoutControllerConfiguration
- Returns:
- path
-
setEnabled
public void setEnabled(boolean enabled)
EnablesLogoutController
. Default value false.- Parameters:
enabled
- true if it is
-
setPath
public void setPath(java.lang.String path)
Path to theLogoutController
. Default value "/logout".- Parameters:
path
- The path
-
isGetAllowed
public boolean isGetAllowed()
- Specified by:
isGetAllowed
in interfaceLogoutControllerConfiguration
- Returns:
- true if you want to support HTTP GET invocations in the
LogoutController
.
-
setGetAllowed
public void setGetAllowed(boolean getAllowed)
Enables HTTP GET invocations ofLogoutController
. Default value (false).- Parameters:
getAllowed
- Whether Http GET should be supported.
-
-