io.micronaut.management.endpoint.annotation

Annotation Type Endpoint

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Singleton
 @ConfigurationReader(prefix="endpoints")
 @Requires(condition=EndpointEnabledCondition.class)
public @interface Endpoint

Defines a management endpoint for a given ID.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultConfigurationId
boolean	defaultEnabled
boolean	defaultSensitive
String	id
String	prefix
String	value

Field Detail

ENABLED

public static final boolean ENABLED

Whether endpoints are enabled by default.

SENSITIVE

public static final boolean SENSITIVE

Whether endpoints are sensitive by default.

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

The default prefix.

ALL

public static final String ALL

The ID used to refer to all.

Element Detail

value

@AliasFor(annotation=ConfigurationReader.class,member="value") @AliasFor(member="id")
public abstract String value

Returns:

The ID of the endpoint

Default:

""

id

@AliasFor(member="value") @AliasFor(annotation=ConfigurationReader.class,member="value")
public abstract String id

Returns:

The ID of the endpoint

Default:

""

prefix

@AliasFor(annotation=ConfigurationReader.class,
          member="prefix")
public abstract String prefix

Returns:

The default prefix to use

Default:

"endpoints"

defaultEnabled

public abstract boolean defaultEnabled

Returns:

If the endpoint is enabled when no configuration is provided

Default:

true

defaultSensitive

public abstract boolean defaultSensitive

Returns:

If the endpoint is sensitive when no configuration is provided

Default:

true

defaultConfigurationId

public abstract String defaultConfigurationId

Returns:

The configuration key to look for when no configuration is provided

Default:

"all"