org.springframework.boot.actuate.endpoint.mvc

Class DocsMvcEndpoint

java.lang.Object

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

org.springframework.boot.actuate.endpoint.mvc.DocsMvcEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, MvcEndpoint, org.springframework.context.EnvironmentAware, org.springframework.web.servlet.config.annotation.WebMvcConfigurer

@ConfigurationProperties(value="endpoints.docs")
public class DocsMvcEndpoint
extends org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter
implements MvcEndpoint, org.springframework.context.EnvironmentAware

MvcEndpoint to expose actuator documentation.

Since:

1.3.0

Author:

Dave Syer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocsMvcEndpoint.Curies Properties of the default CurieProvider (used for adding docs links).

Field Summary

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

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
DocsMvcEndpoint(ManagementServletContext managementServletContext)

Method Summary

Modifier and Type	Method and Description
void	addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry)
String	browse()
DocsMvcEndpoint.Curies	getCuries()
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.
boolean	isEnabled()
boolean	isSensitive() Return if the endpoint exposes sensitive information.
String	redirect()
void	setEnabled(boolean enabled)
void	setEnvironment(org.springframework.core.env.Environment environment)
void	setPath(String path)
void	setSensitive(Boolean sensitive)

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

addArgumentResolvers, addCorsMappings, addFormatters, addInterceptors, 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

DocsMvcEndpoint

public DocsMvcEndpoint(ManagementServletContext managementServletContext)

Method Detail

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

getCuries

public DocsMvcEndpoint.Curies getCuries()

browse

@RequestMapping(value="/",
                produces="text/html")
public String browse()

redirect

@RequestMapping(value="",
                produces="text/html")
public String redirect()

addResourceHandlers

public void addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry)

Specified by:

addResourceHandlers in interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

Overrides:

addResourceHandlers in class org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

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

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

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)

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