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
Modifier and TypeOptional ElementDescriptionboolean
boolean
-
Field Summary
-
Field Details
-
ENABLED
static final boolean ENABLEDWhether endpoints are enabled by default.- See Also:
-
SENSITIVE
static final boolean SENSITIVEWhether endpoints are sensitive by default.- See Also:
-
DEFAULT_PREFIX
The default prefix.- See Also:
-
ALL
The ID used to refer to all.- See Also:
-
-
Element Details
-
value
- Returns:
- The ID of the endpoint
- Default:
- ""
-
id
- Returns:
- The ID of the endpoint
- Default:
- ""
-
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"
-