Package io.micronaut.management.endpoint.annotation

Annotation Interface Endpoint

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

Defines a management endpoint for a given ID.

Since:

1.0

Author:

Graeme Rocher

Optional Element Summary

Optional Elements

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

Field Summary

Fields

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

Field Details

ENABLED

static final boolean ENABLED

Whether endpoints are enabled by default.

See Also:

• Constant Field Values

SENSITIVE

static final boolean SENSITIVE

Whether endpoints are sensitive by default.

See Also:

• Constant Field Values

DEFAULT_PREFIX

static final String DEFAULT_PREFIX

The default prefix.

See Also:

• Constant Field Values

ALL

static final String ALL

The ID used to refer to all.

See Also:

• Constant Field Values

Element Details

value

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

Returns:

The ID of the endpoint

Default:

""

id

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

Returns:

The ID of the endpoint

Default:

""

prefix

@AliasFor(annotation=ConfigurationReader.class,
          member="basePrefix")
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

String defaultConfigurationId

Returns:

The configuration key to look for when no configuration is provided

Default:

"all"