Class EndpointDefaultConfiguration

java.lang.Object
io.micronaut.management.endpoint.EndpointDefaultConfiguration
@ConfigurationProperties("endpoints.all") public class EndpointDefaultConfiguration extends Object
The default Endpoint configuration.
Since:
1.0
Author:
James Kleeh

  • Field Details

    • PREFIX

      public static final String PREFIX
      The prefix for endpoints settings.
      See Also:

    • PATH

      public static final String PATH
      The path for endpoints settings.
      See Also:

    • CONTEXT_PATH

      public static final String CONTEXT_PATH
      The context for endpoints settings.
      See Also:

    • PORT

      public static final String PORT
      The path for endpoints settings.
      See Also:

    • DEFAULT_ENDPOINT_BASE_PATH

      public static final String DEFAULT_ENDPOINT_BASE_PATH
      The default base path.
      See Also:

    • DEFAULT_ENDPOINT_CONTEXT_PATH

      public static final @Nullable String DEFAULT_ENDPOINT_CONTEXT_PATH
      The default context path.

  • Constructor Details

    • EndpointDefaultConfiguration

      public EndpointDefaultConfiguration()

  • Method Details

    • getPath

      public String getPath()
      Returns:
      endpoints Base Path (defaults to: "/")

    • getContextPath

      public @Nullable String getContextPath()
      Returns:
      endpoints Context Path (defaults is null)

    • isEnabled

      public Optional<Boolean> isEnabled()
      Returns:
      Whether the endpoint is enabled

    • isSensitive

      public Optional<Boolean> isSensitive()
      Returns:
      Does the endpoint expose sensitive information

    • setEnabled

      public void setEnabled(Boolean enabled)
      Sets whether the endpoint is enabled.
      Parameters:
      enabled - True it is enabled, null for the default behaviour

    • setSensitive

      public void setSensitive(Boolean sensitive)
      Sets whether the endpoint is sensitive.
      Parameters:
      sensitive - True it is sensitive, null for the default behaviour

    • setPath

      public void setPath(String path)
      The endpoints base path. It must include a leading and trailing '/'. Default value ("/").
      Parameters:
      path - The path

    • setContextPath

      public void setContextPath(String contextPath)
      The endpoints context path. Default value is null.
      Parameters:
      contextPath - The Context Path

    • getPort

      public Optional<Integer> getPort()
      Returns:
      The port to expose endpoints via.

    • setPort

      public void setPort(@Nullable Integer port)
      Sets the port to expose endpoints via.
      Parameters:
      port - The port