Package io.micronaut.management.endpoint

Class EndpointDefaultConfiguration

  • @ConfigurationProperties("endpoints.all")
public class EndpointDefaultConfiguration
extends java.lang.Object
    The default Endpoint configuration.
    Since:
    1.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_ENDPOINT_BASE_PATH
      The default base path.
      static java.lang.String PATH
      The path for endpoints settings.
      static java.lang.String PORT
      The path for endpoints settings.
      static java.lang.String PREFIX
      The prefix for endpoints settings.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getPath()  
      java.util.Optional<java.lang.Integer> getPort()  
      java.util.Optional<java.lang.Boolean> isEnabled()  
      java.util.Optional<java.lang.Boolean> isSensitive()  
      void setEnabled​(java.lang.Boolean enabled)
      Sets whether the endpoint is enabled.
      void setPath​(java.lang.String path)
      The endpoints base path.
      void setPort​(java.lang.Integer port)
      Sets the port to expose endpoints via.
      void setSensitive​(java.lang.Boolean sensitive)
      Sets whether the endpoint is sensitive.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • PREFIX

        public static final java.lang.String PREFIX
        The prefix for endpoints settings.
        See Also:
        Constant Field Values

      • PATH

        public static final java.lang.String PATH
        The path for endpoints settings.
        See Also:
        Constant Field Values

      • PORT

        public static final java.lang.String PORT
        The path for endpoints settings.
        See Also:
        Constant Field Values

      • DEFAULT_ENDPOINT_BASE_PATH

        public static final java.lang.String DEFAULT_ENDPOINT_BASE_PATH
        The default base path.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EndpointDefaultConfiguration

        public EndpointDefaultConfiguration()

    • Method Detail

      • getPath

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

      • isEnabled

        public java.util.Optional<java.lang.Boolean> isEnabled()
        Returns:
        Whether the endpoint is enabled

      • isSensitive

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

      • setEnabled

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

      • setSensitive

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

      • setPath

        public void setPath​(java.lang.String path)
        The endpoints base path. Default value ("/").
        Parameters:
        path - The path

      • getPort

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

      • setPort

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