org.springframework.boot.actuate.endpoint.mvc

Class AbstractNamedMvcEndpoint

java.lang.Object

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

org.springframework.boot.actuate.endpoint.mvc.AbstractNamedMvcEndpoint

All Implemented Interfaces:

Aware, MvcEndpoint, NamedMvcEndpoint, EnvironmentAware, WebMvcConfigurer

Direct Known Subclasses:

AuditEventsMvcEndpoint, DocsMvcEndpoint, HalJsonMvcEndpoint, HeapdumpMvcEndpoint, JolokiaMvcEndpoint, LogFileMvcEndpoint

public abstract class AbstractNamedMvcEndpoint
extends AbstractMvcEndpoint
implements NamedMvcEndpoint

Abstract base class for NamedMvcEndpoint implementations without a backing Endpoint.

Since:

1.5.0

Author:

Madhura Bhave

Field Summary

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

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
AbstractNamedMvcEndpoint(String name, String path, boolean sensitive)
AbstractNamedMvcEndpoint(String name, String path, boolean sensitive, boolean enabled)

Method Summary

Modifier and Type	Method and Description
String	getName() Return the logical name of the endpoint.

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

getEndpointType, getEnvironment, getPath, isEnabled, isSensitive, setEnabled, setEnvironment, setPath, setSensitive

Methods inherited from class java.lang.Object

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

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

getEndpointType, getPath, isSensitive

Methods inherited from interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

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

Constructor Detail

AbstractNamedMvcEndpoint

public AbstractNamedMvcEndpoint(String name,
                                String path,
                                boolean sensitive)

AbstractNamedMvcEndpoint

public AbstractNamedMvcEndpoint(String name,
                                String path,
                                boolean sensitive,
                                boolean enabled)

Method Detail

getName

public String getName()

Description copied from interface: NamedMvcEndpoint

Return the logical name of the endpoint. Names should be non-null, non-empty, alpha-numeric values.

Specified by:

getName in interface NamedMvcEndpoint

Returns:

the logical name of the endpoint