Class EnvironmentEndpoint
java.lang.Object
io.micronaut.management.endpoint.env.EnvironmentEndpoint
Endpoint
that displays information about the environment and its property sources.- Since:
- 1.2.0
- Author:
- Álvaro Sánchez-Mariscal
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionEnvironmentEndpoint
(Environment environment) EnvironmentEndpoint
(Environment environment, @Nullable EnvironmentEndpointFilter environmentFilter) -
Method Summary
Modifier and TypeMethodDescriptionGets the keys to be displayed by the environment endpoint.getProperties
(String propertySourceName) void
setActiveKeys
(List<String> activeKeys) Sets the sections to be displayed by the environment endpoint.
-
Field Details
-
NAME
Endpoint name.- See Also:
-
-
Constructor Details
-
EnvironmentEndpoint
- Parameters:
environment
- TheEnvironment
-
EnvironmentEndpoint
@Inject public EnvironmentEndpoint(Environment environment, @Nullable @Nullable EnvironmentEndpointFilter environmentFilter) - Parameters:
environment
- TheEnvironment
environmentFilter
- The registeredEnvironmentEndpointFilter
bean if one is registered
-
-
Method Details
-
getActiveKeys
Gets the keys to be displayed by the environment endpoint. Defaults to ["activeEnvironments", "packages", "propertySources"] if not configured. Configurable viaendpoints.env.active-keys
.- Returns:
- The list of active sections.
-
setActiveKeys
Sets the sections to be displayed by the environment endpoint. Example:endpoints.env.active-keys=activeEnvironments,packages
- Parameters:
activeKeys
- The list of sections. If an empty list is provided, no sections will be displayed.
-
getEnvironmentInfo
- Returns:
- The environment information as a map with the following keys: activeEnvironments, packages and propertySources.
-
getProperties
- Parameters:
propertySourceName
- ThePropertySource
name- Returns:
- a map with all the properties defined in the property source if it exists; null otherwise.
-