io.micronaut.management.endpoint.env

Class EnvironmentEndpoint

java.lang.Object

io.micronaut.management.endpoint.env.EnvironmentEndpoint

@Endpoint(id="env",
          defaultEnabled=false)
public class EnvironmentEndpoint
extends Object

Endpoint that displays information about the environment and its property sources.

Since:

1.2.0

Author:

Álvaro Sánchez-Mariscal

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Endpoint name.

Constructor Summary

Constructors

Constructor and Description
EnvironmentEndpoint(Environment environment)
EnvironmentEndpoint(Environment environment, EnvironmentEndpointFilter environmentFilter)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getEnvironmentInfo()
Map<String,Object>	getProperties(String propertySourceName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

Endpoint name.

See Also:

Constant Field Values

Constructor Detail

EnvironmentEndpoint

public EnvironmentEndpoint(Environment environment)

Parameters:

environment - The Environment

EnvironmentEndpoint

@Inject
public EnvironmentEndpoint(Environment environment,
                                   @Nullable
                                   EnvironmentEndpointFilter environmentFilter)

Parameters:

environment - The Environment

environmentFilter - The registered EnvironmentEndpointFilter bean if one is registered

Method Detail

getEnvironmentInfo

@Read
public Map<String,Object> getEnvironmentInfo()

Returns:

The environment information as a map with the following keys: activeEnvironments, packages and propertySources.

getProperties

@Read
public Map<String,Object> getProperties(@Selector
                                              String propertySourceName)

Parameters:

propertySourceName - The PropertySource name

Returns:

a map with all the properties defined in the property source if it exists; null otherwise.