Package io.micronaut.management.endpoint.annotation

Annotation Type Endpoint

  • @Documented
@Retention(RUNTIME)
@Target(TYPE)
@Singleton
@ConfigurationReader(prefix="endpoints")
@Requires(condition=EndpointEnabledCondition.class)
public @interface Endpoint
    Defines a management endpoint for a given ID.
    Since:
    1.0

    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static java.lang.String ALL
      The ID used to refer to all.
      static java.lang.String DEFAULT_PREFIX
      The default prefix.
      static boolean ENABLED
      Whether endpoints are enabled by default.
      static boolean SENSITIVE
      Whether endpoints are sensitive by default.

    • Field Detail

      • ENABLED

        static final boolean ENABLED
        Whether endpoints are enabled by default.

      • SENSITIVE

        static final boolean SENSITIVE
        Whether endpoints are sensitive by default.

      • DEFAULT_PREFIX

        static final java.lang.String DEFAULT_PREFIX
        The default prefix.

      • ALL

        static final java.lang.String ALL
        The ID used to refer to all.

    • Element Detail

      • value

        @AliasFor(annotation=io.micronaut.context.annotation.ConfigurationReader.class,member="value") @AliasFor(member="id")
java.lang.String value
        Returns:
        The ID of the endpoint
        Default:
        ""

      • id

        @AliasFor(member="value") @AliasFor(annotation=io.micronaut.context.annotation.ConfigurationReader.class,member="value")
java.lang.String id
        Returns:
        The ID of the endpoint
        Default:
        ""

      • prefix

        @AliasFor(annotation=io.micronaut.context.annotation.ConfigurationReader.class,
          member="prefix")
java.lang.String prefix
        Returns:
        The default prefix to use
        Default:
        "endpoints"

      • defaultEnabled

        boolean defaultEnabled
        Returns:
        If the endpoint is enabled when no configuration is provided
        Default:
        true

      • defaultSensitive

        boolean defaultSensitive
        Returns:
        If the endpoint is sensitive when no configuration is provided
        Default:
        true

      • defaultConfigurationId

        java.lang.String defaultConfigurationId
        Returns:
        The configuration key to look for when no configuration is provided
        Default:
        "all"