org.springframework.boot.actuate.autoconfigure.endpoint

Class EndpointEnablementProvider

java.lang.Object

org.springframework.boot.actuate.autoconfigure.endpoint.EndpointEnablementProvider

public class EndpointEnablementProvider
extends Object

Determines an endpoint's enablement based on the current Environment.

Since:

2.0.0

Author:

Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
EndpointEnablementProvider(org.springframework.core.env.Environment environment) Creates a new instance with the Environment to use.

Method Summary

Modifier and Type	Method and Description
EndpointEnablement	getEndpointEnablement(String endpointId, DefaultEnablement defaultEnablement) Return the EndpointEnablement of an endpoint with no specific tech exposure.
EndpointEnablement	getEndpointEnablement(String endpointId, DefaultEnablement defaultEnablement, EndpointExposure exposure) Return the EndpointEnablement of an endpoint for a specific tech exposure.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointEnablementProvider

public EndpointEnablementProvider(org.springframework.core.env.Environment environment)

Creates a new instance with the Environment to use.

Parameters:

environment - the environment

Method Detail

getEndpointEnablement

public EndpointEnablement getEndpointEnablement(String endpointId,
                                                DefaultEnablement defaultEnablement)

Return the EndpointEnablement of an endpoint with no specific tech exposure.

Parameters:

endpointId - the id of the endpoint

defaultEnablement - the DefaultEnablement of the endpoint

Returns:

the EndpointEnablement of that endpoint

getEndpointEnablement

public EndpointEnablement getEndpointEnablement(String endpointId,
                                                DefaultEnablement defaultEnablement,
                                                EndpointExposure exposure)

Return the EndpointEnablement of an endpoint for a specific tech exposure.

Parameters:

endpointId - the id of the endpoint

defaultEnablement - the DefaultEnablement of the endpoint

exposure - the requested EndpointExposure

Returns:

the EndpointEnablement of that endpoint for the specified EndpointExposure