org.springframework.boot.actuate.endpoint.web.servlet

Class WebMvcEndpointHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.handler.AbstractHandlerMapping

org.springframework.web.servlet.handler.AbstractHandlerMethodMapping<RequestMappingInfo>

org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping

org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping

org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping

All Implemented Interfaces:

Aware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, ServletContextAware, MatchableHandlerMapping, HandlerMapping

public class WebMvcEndpointHandlerMapping
extends AbstractWebMvcEndpointHandlerMapping

A custom HandlerMapping that makes web endpoints available over HTTP using Spring MVC.

Since:

2.0.0

Author:

Andy Wilkinson, Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping

AbstractWebMvcEndpointHandlerMapping.LinksHandler, AbstractWebMvcEndpointHandlerMapping.ServletWebOperation

Field Summary

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.web.servlet.HandlerMapping

BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
WebMvcEndpointHandlerMapping(EndpointMapping endpointMapping, Collection<ExposableWebEndpoint> endpoints, EndpointMediaTypes endpointMediaTypes, CorsConfiguration corsConfiguration, EndpointLinksResolver linksResolver, boolean shouldRegisterLinksMapping) Creates a new WebMvcEndpointHandlerMapping instance that provides mappings for the given endpoints.

Method Summary

Modifier and Type	Method and Description
protected AbstractWebMvcEndpointHandlerMapping.LinksHandler	getLinksHandler() Return the Handler providing actuator links at the root endpoint.

Methods inherited from class org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping

createHandlerMethod, extendInterceptors, getEndpoints, getMappingForMethod, hasCorsConfigurationSource, initCorsConfiguration, initHandlerMethods, isHandler, match, wrapServletWebOperation

Methods inherited from class org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping

getDirectPaths, getHandlerInternal, getMappingComparator, getMappingPathPatterns, getMatchingMapping, handleMatch, handleNoMatch

Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMethodMapping

afterPropertiesSet, detectHandlerMethods, getCandidateBeanNames, getCorsConfiguration, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, lookupHandlerMethod, processCandidateBean, registerHandlerMethod, registerMapping, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, setPatternParser, unregisterMapping

Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping

adaptInterceptor, detectMappedInterceptors, formatMappingName, getAdaptedInterceptors, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getPatternParser, getUrlPathHelper, initApplicationContext, initInterceptors, initLookupPath, setAlwaysUseFullPath, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper, usesPathPatterns

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.InitializingBean

afterPropertiesSet

Methods inherited from interface org.springframework.web.servlet.handler.MatchableHandlerMapping

getPatternParser

Methods inherited from interface org.springframework.web.servlet.HandlerMapping

getHandler, usesPathPatterns

Constructor Detail

WebMvcEndpointHandlerMapping

public WebMvcEndpointHandlerMapping(EndpointMapping endpointMapping,
                                    Collection<ExposableWebEndpoint> endpoints,
                                    EndpointMediaTypes endpointMediaTypes,
                                    CorsConfiguration corsConfiguration,
                                    EndpointLinksResolver linksResolver,
                                    boolean shouldRegisterLinksMapping)

Creates a new WebMvcEndpointHandlerMapping instance that provides mappings for the given endpoints.

Parameters:

endpointMapping - the base mapping for all endpoints

endpoints - the web endpoints

endpointMediaTypes - media types consumed and produced by the endpoints

corsConfiguration - the CORS configuration for the endpoints or null

linksResolver - resolver for determining links to available endpoints

shouldRegisterLinksMapping - whether the links endpoint should be registered

Method Detail

getLinksHandler

protected AbstractWebMvcEndpointHandlerMapping.LinksHandler getLinksHandler()

Description copied from class: AbstractWebMvcEndpointHandlerMapping

Return the Handler providing actuator links at the root endpoint.

Specified by:

getLinksHandler in class AbstractWebMvcEndpointHandlerMapping

Returns:

the links handler