Package io.micronaut.management.endpoint

Class EndpointConfiguration

java.lang.Object

io.micronaut.management.endpoint.EndpointConfiguration

@EachProperty("endpoints")
public class EndpointConfiguration
extends Object

An Endpoint configuration.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	The prefix for endpoints configurations.

Constructor Summary

Constructors

Constructor	Description
EndpointConfiguration(String id, EndpointDefaultConfiguration defaultConfiguration)

Method Summary

Modifier and Type	Method	Description
String	getId()
@Nullable String	getPath()	Endpoint's path.
Optional<Boolean>	isEnabled()
Optional<Boolean>	isSensitive()
void	setEnabled(Boolean enabled)	Sets whether the endpoint is enabled.
void	setPath(@Nullable String path)	Endpoint's path.
void	setSensitive(Boolean sensitive)	Sets whether the endpoint is sensitive.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

The prefix for endpoints configurations.

See Also:

• Constant Field Values

Constructor Details

EndpointConfiguration

public EndpointConfiguration(@Parameter
 String id,
 EndpointDefaultConfiguration defaultConfiguration)

Parameters:

id - The id of the endpoint

defaultConfiguration - The default endpoint configuration

Method Details

getId

public String getId()

Returns:

The ID of the endpoint

See Also:

• Endpoint.value()

isEnabled

public Optional<Boolean> isEnabled()

Returns:

Is the endpoint enabled. If not present, use the value of Endpoint.defaultEnabled()

isSensitive

public Optional<Boolean> isSensitive()

Returns:

Does the endpoint expose sensitive information. If not present, use the value of Endpoint.defaultSensitive()

setEnabled

public void setEnabled(Boolean enabled)

Sets whether the endpoint is enabled.

Parameters:

enabled - True it is enabled, null for the default behaviour

setSensitive

public void setSensitive(Boolean sensitive)

Sets whether the endpoint is sensitive.

Parameters:

sensitive - True it is sensitive, null for the default behaviour

setPath

public void setPath(@Nullable
 @Nullable String path)

Endpoint's path. If not set the endpoint name is used as the path.

Parameters:

path - Endpoint's path

Since:

4.8.0

getPath

@Nullable
public @Nullable String getPath()

Endpoint's path. If not set the endpoint name is used as the path.

Returns:

Endpoint's path

Since:

4.8.0