org.springframework.boot.actuate.endpoint.mvc

Class HealthMvcEndpoint

java.lang.Object

org.springframework.boot.actuate.endpoint.mvc.AbstractEndpointMvcAdapter<HealthEndpoint>

org.springframework.boot.actuate.endpoint.mvc.HealthMvcEndpoint

All Implemented Interfaces:

MvcEndpoint, NamedMvcEndpoint

@ConfigurationProperties(prefix="endpoints.health")
public class HealthMvcEndpoint
extends AbstractEndpointMvcAdapter<HealthEndpoint>

Adapter to expose HealthEndpoint as an MvcEndpoint.

Since:

1.1.0

Author:

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

Field Summary

Fields inherited from interface org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
HealthMvcEndpoint(HealthEndpoint delegate)
HealthMvcEndpoint(HealthEndpoint delegate, boolean secure)
HealthMvcEndpoint(HealthEndpoint delegate, boolean secure, List<String> roles)

Method Summary

Modifier and Type	Method and Description
void	addStatusMapping(Map<String,HttpStatus> statusMapping) Add specific status mappings to the existing set.
void	addStatusMapping(Status status, HttpStatus httpStatus) Add a status mapping to the existing set.
void	addStatusMapping(String statusCode, HttpStatus httpStatus) Add a status mapping to the existing set.
protected boolean	exposeHealthDetails(HttpServletRequest request, Principal principal)
Object	invoke(HttpServletRequest request, Principal principal)
void	setStatusMapping(Map<String,HttpStatus> statusMapping) Set specific status mappings.

Methods inherited from class org.springframework.boot.actuate.endpoint.mvc.AbstractEndpointMvcAdapter

getDelegate, getDisabledResponse, getEndpointType, getName, getPath, invoke, isSensitive, setPath

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthMvcEndpoint

public HealthMvcEndpoint(HealthEndpoint delegate)

HealthMvcEndpoint

public HealthMvcEndpoint(HealthEndpoint delegate,
                         boolean secure)

HealthMvcEndpoint

public HealthMvcEndpoint(HealthEndpoint delegate,
                         boolean secure,
                         List<String> roles)

Method Detail

setStatusMapping

public void setStatusMapping(Map<String,HttpStatus> statusMapping)

Set specific status mappings.

Parameters:

statusMapping - a map of status code to HttpStatus

addStatusMapping

public void addStatusMapping(Map<String,HttpStatus> statusMapping)

Add specific status mappings to the existing set.

Parameters:

statusMapping - a map of status code to HttpStatus

addStatusMapping

public void addStatusMapping(Status status,
                             HttpStatus httpStatus)

Add a status mapping to the existing set.

Parameters:

status - the status to map

httpStatus - the http status

addStatusMapping

public void addStatusMapping(String statusCode,
                             HttpStatus httpStatus)

Add a status mapping to the existing set.

Parameters:

statusCode - the status code to map

httpStatus - the http status

invoke

@ActuatorGetMapping
 @ResponseBody
public Object invoke(HttpServletRequest request,
                                                        Principal principal)

exposeHealthDetails

protected boolean exposeHealthDetails(HttpServletRequest request,
                                      Principal principal)