org.springframework.boot.actuate.endpoint.mvc

Class AbstractMvcEndpoint

java.lang.Object

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

org.springframework.boot.actuate.endpoint.mvc.AbstractMvcEndpoint

All Implemented Interfaces:

Aware, MvcEndpoint, EnvironmentAware, WebMvcConfigurer

Direct Known Subclasses:

DocsMvcEndpoint, HalJsonMvcEndpoint, HeapdumpMvcEndpoint, JolokiaMvcEndpoint, LogFileMvcEndpoint

public abstract class AbstractMvcEndpoint
extends WebMvcConfigurerAdapter
implements MvcEndpoint, EnvironmentAware

Abstract base class for MvcEndpoint implementations without a backing Endpoint.

Since:

1.4.0

Author:

Phillip Webb, Lari Hotari

Field Summary

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

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
AbstractMvcEndpoint(String path, boolean sensitive)
AbstractMvcEndpoint(String path, boolean sensitive, boolean enabled)

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 Environment	getEnvironment()
String	getPath() Return the MVC path of the endpoint.
boolean	isEnabled()
boolean	isSensitive() Return if the endpoint exposes sensitive information.
void	setEnabled(Boolean enabled)
void	setEnvironment(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, addResourceHandlers, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, configurePathMatch, configureViewResolvers, extendHandlerExceptionResolvers, extendMessageConverters, getMessageCodesResolver, getValidator

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMvcEndpoint

public AbstractMvcEndpoint(String path,
                           boolean sensitive)

AbstractMvcEndpoint

public AbstractMvcEndpoint(String path,
                           boolean sensitive,
                           boolean enabled)

Method Detail

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

getEnvironment

protected final Environment getEnvironment()

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

setPath

public void setPath(String 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