org.springframework.boot.actuate.health

Class HealthEndpointWebExtension

java.lang.Object

org.springframework.boot.actuate.health.HealthEndpointWebExtension

@EndpointWebExtension(endpoint=HealthEndpoint.class)
public class HealthEndpointWebExtension
extends Object

@EndpointWebExtension for the HealthEndpoint.

Since:

2.0.0

Author:

Christian Dupuis, Dave Syer, Andy Wilkinson, Phillip Webb, Eddú Meléndez, Madhura Bhave, Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
HealthEndpointWebExtension(HealthContributorRegistry registry, HealthEndpointGroups groups) Create a new HealthEndpointWebExtension instance.
HealthEndpointWebExtension(HealthEndpoint delegate, HealthWebEndpointResponseMapper responseMapper) Deprecated. since 2.2.0 in favor of HealthEndpointWebExtension(HealthContributorRegistry, HealthEndpointGroups)

Method Summary

Modifier and Type	Method and Description
protected HealthComponent	aggregateContributions(ApiVersion apiVersion, Map<String,HealthComponent> contributions, StatusAggregator statusAggregator, boolean showComponents, Set<String> groupNames)
protected CompositeHealth	getCompositeHealth(ApiVersion apiVersion, Map<String,HealthComponent> components, StatusAggregator statusAggregator, boolean showComponents, Set<String> groupNames)
protected HealthComponent	getHealth(HealthContributor contributor, boolean includeDetails)
WebEndpointResponse<HealthComponent>	health(ApiVersion apiVersion, SecurityContext securityContext)
WebEndpointResponse<HealthComponent>	health(ApiVersion apiVersion, SecurityContext securityContext, boolean showAll, String... path)
WebEndpointResponse<HealthComponent>	health(ApiVersion apiVersion, SecurityContext securityContext, String... path)

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthEndpointWebExtension

@Deprecated
public HealthEndpointWebExtension(HealthEndpoint delegate,
                                              HealthWebEndpointResponseMapper responseMapper)

Deprecated. since 2.2.0 in favor of HealthEndpointWebExtension(HealthContributorRegistry, HealthEndpointGroups)

Create a new HealthEndpointWebExtension instance using a delegate endpoint.

Parameters:

delegate - the delegate endpoint

responseMapper - the response mapper

HealthEndpointWebExtension

public HealthEndpointWebExtension(HealthContributorRegistry registry,
                                  HealthEndpointGroups groups)

Create a new HealthEndpointWebExtension instance.

Parameters:

registry - the health contributor registry

groups - the health endpoint groups

Method Detail

health

@ReadOperation
public WebEndpointResponse<HealthComponent> health(ApiVersion apiVersion,
                                                                  SecurityContext securityContext)

health

@ReadOperation
public WebEndpointResponse<HealthComponent> health(ApiVersion apiVersion,
                                                                  SecurityContext securityContext,
                                                                  @Selector(match=ALL_REMAINING)
                                                                  String... path)

health

public WebEndpointResponse<HealthComponent> health(ApiVersion apiVersion,
                                                   SecurityContext securityContext,
                                                   boolean showAll,
                                                   String... path)

getHealth

protected HealthComponent getHealth(HealthContributor contributor,
                                    boolean includeDetails)

aggregateContributions

protected HealthComponent aggregateContributions(ApiVersion apiVersion,
                                                 Map<String,HealthComponent> contributions,
                                                 StatusAggregator statusAggregator,
                                                 boolean showComponents,
                                                 Set<String> groupNames)

getCompositeHealth

protected final CompositeHealth getCompositeHealth(ApiVersion apiVersion,
                                                   Map<String,HealthComponent> components,
                                                   StatusAggregator statusAggregator,
                                                   boolean showComponents,
                                                   Set<String> groupNames)