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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription@NonNull String
getPath()
boolean
boolean
void
setEnabled
(boolean enabled) EnablesLogoutController
.void
setGetAllowed
(boolean getAllowed) Enables HTTP GET invocations ofLogoutController
.void
Path to theLogoutController
.
-
Field Details
-
PREFIX
- See Also:
-
DEFAULT_ENABLED
public static final boolean DEFAULT_ENABLEDThe default enable value.- See Also:
-
DEFAULT_PATH
The default path.- See Also:
-
DEFAULT_GETALLOWED
public static final boolean DEFAULT_GETALLOWEDDefault Get Allowed.- See Also:
-
-
Constructor Details
-
LogoutControllerConfigurationProperties
public LogoutControllerConfigurationProperties()
-
-
Method Details
-
isEnabled
public boolean isEnabled()- Specified by:
isEnabled
in interfaceio.micronaut.core.util.Toggleable
- Returns:
- true if you want to enable the
LogoutController
-
getPath
- Specified by:
getPath
in interfaceControllerConfiguration
- Returns:
- the path where the controller is enabled.
-
setEnabled
public void setEnabled(boolean enabled) EnablesLogoutController
. Default value true.- Parameters:
enabled
- true if it is
-
setPath
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.
-