org.springframework.boot.actuate.endpoint.mvc

Class HealthMvcEndpoint

java.lang.Object

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

All Implemented Interfaces:

Aware, MvcEndpoint, EnvironmentAware

public class HealthMvcEndpoint
extends Object
implements MvcEndpoint, EnvironmentAware

Adapter to expose HealthEndpoint as an MvcEndpoint.

Since:

1.1.0

Author:

Christian Dupuis, Dave Syer, Andy Wilkinson, Phillip Webb

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)

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.
Class<? extends Endpoint>	getEndpointType() Return the type of Endpoint exposed, or null if this MvcEndpoint exposes information that cannot be represented as a traditional Endpoint.
String	getPath() Return the MVC path of the endpoint.
Object	invoke(Principal principal)
boolean	isSensitive() Return if the endpoint exposes sensitive information.
void	setEnvironment(Environment environment)
void	setStatusMapping(Map<String,HttpStatus> statusMapping) Set specific status mappings.

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)

Method Detail

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

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

@RequestMapping
 @ResponseBody
public Object invoke(Principal principal)

getPath

public String getPath()

Description copied from interface: MvcEndpoint

Return the MVC path of the endpoint.

Specified by:

getPath in interface MvcEndpoint

Returns:

the endpoint path

isSensitive

public boolean isSensitive()

Description copied from interface: MvcEndpoint

Return if the endpoint exposes sensitive information.

Specified by:

isSensitive in interface MvcEndpoint

Returns:

if the endpoint is sensitive

getEndpointType

public Class<? extends Endpoint> getEndpointType()

Description copied from interface: MvcEndpoint

Return the type of Endpoint exposed, or null if this MvcEndpoint exposes information that cannot be represented as a traditional Endpoint.

Specified by:

getEndpointType in interface MvcEndpoint

Returns:

the endpoint type