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 Details

    • PREFIX

      public static final String PREFIX
      See Also:

    • DEFAULT_ENABLED

      @Deprecated(forRemoval=true, since="4.11.0") public static final boolean DEFAULT_ENABLED
      Deprecated, for removal: This API element is subject to removal in a future version.
      Not used. ControllerConfigurationProperties.DEFAULT_ENABLED is used instead.
      The default enable value.
      See Also:

    • DEFAULT_PATH

      public static final String DEFAULT_PATH
      The default path.
      See Also:

    • DEFAULT_GETALLOWED

      public static final boolean DEFAULT_GETALLOWED
      Default Get Allowed.
      See Also:

  • Constructor Details

    • LogoutControllerConfigurationProperties

      public LogoutControllerConfigurationProperties()

  • Method Details

    • 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.

    • getPostContentTypes

      public Set<String> getPostContentTypes()
      Specified by:
      getPostContentTypes in interface ControllerConfiguration
      Returns:
      Supported HTTP methods for POST endpoints.

    • setPostContentTypes

      public void setPostContentTypes(Set<String> postContentTypes)
      Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded
      Parameters:
      postContentTypes - supported content types for POST endpoints.

    • isEnabled

      public boolean isEnabled()
      Whether the controller is enabled.
      Specified by:
      isEnabled in interface io.micronaut.core.util.Toggleable
      Returns:
      Whether the controller is enabled.

    • getPath

      @NonNull public @NonNull String getPath()
      Specified by:
      getPath in interface ControllerConfiguration
      Returns:
      the path where the controller is enabled.