org.springframework.boot.actuate.endpoint.mvc

Class ActuatorHalJsonEndpoint

java.lang.Object

org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

org.springframework.boot.actuate.endpoint.mvc.ActuatorHalJsonEndpoint

All Implemented Interfaces:

MvcEndpoint, WebMvcConfigurer

Direct Known Subclasses:

ActuatorHalBrowserEndpoint

@ConfigurationProperties(value="endpoints.actuator")
public class ActuatorHalJsonEndpoint
extends WebMvcConfigurerAdapter
implements MvcEndpoint

MvcEndpoint to expose HAL-formatted JSON.

Since:

1.3.0

Author:

Dave Syer, Phillip Webb, Andy Wilkinson

Field Summary

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

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
ActuatorHalJsonEndpoint(ManagementServletContext managementServletContext)

Method Summary

Modifier and Type	Method and Description
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.
protected ManagementServletContext	getManagementServletContext()
String	getPath() Return the MVC path of the endpoint.
boolean	isEnabled()
boolean	isSensitive() Return if the endpoint exposes sensitive information.
org.springframework.hateoas.ResourceSupport	links()
void	setEnabled(boolean enabled)
void	setPath(String path)
void	setSensitive(boolean sensitive)

Methods inherited from class org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

addArgumentResolvers, addCorsMappings, addFormatters, addInterceptors, addResourceHandlers, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, configurePathMatch, configureViewResolvers, extendMessageConverters, getMessageCodesResolver, getValidator

Methods inherited from class java.lang.Object

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

Constructor Detail

ActuatorHalJsonEndpoint

public ActuatorHalJsonEndpoint(ManagementServletContext managementServletContext)

Method Detail

links

@RequestMapping(produces="application/json")
 @ResponseBody
public org.springframework.hateoas.ResourceSupport links()

setPath

public void setPath(String path)

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

setSensitive

public void setSensitive(boolean sensitive)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

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

getManagementServletContext

protected final ManagementServletContext getManagementServletContext()