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

Class AbstractWebMvcEndpointHandlerMapping

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<org.springframework.web.servlet.mvc.method.RequestMappingInfo>

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

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

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.HandlerMapping

Direct Known Subclasses:

WebMvcEndpointHandlerMapping

public abstract class AbstractWebMvcEndpointHandlerMapping
extends org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping
implements org.springframework.beans.factory.InitializingBean

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

Since:

2.0.0

Author:

Andy Wilkinson, Madhura Bhave

Field Summary

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

logger

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

BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, 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
AbstractWebMvcEndpointHandlerMapping(EndpointMapping endpointMapping, Collection<EndpointInfo<WebOperation>> collection, EndpointMediaTypes endpointMediaTypes) Creates a new WebEndpointHandlerMapping that provides mappings for the operations of the given webEndpoints.
AbstractWebMvcEndpointHandlerMapping(EndpointMapping endpointMapping, Collection<EndpointInfo<WebOperation>> webEndpoints, EndpointMediaTypes endpointMediaTypes, org.springframework.web.cors.CorsConfiguration corsConfiguration) Creates a new WebEndpointHandlerMapping that provides mappings for the operations of the given webEndpoints.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.web.servlet.mvc.method.RequestMappingInfo	createRequestMappingInfo(WebOperation operationInfo)
protected void	extendInterceptors(List<Object> interceptors)
EndpointMapping	getEndpointMapping()
Collection<EndpointInfo<WebOperation>>	getEndpoints()
protected abstract Method	getLinks()
protected org.springframework.web.servlet.mvc.method.RequestMappingInfo	getMappingForMethod(Method method, Class<?> handlerType)
protected org.springframework.web.cors.CorsConfiguration	initCorsConfiguration(Object handler, Method method, org.springframework.web.servlet.mvc.method.RequestMappingInfo mapping)
protected void	initHandlerMethods()
protected boolean	isHandler(Class<?> beanType)
protected abstract void	registerMappingForOperation(WebOperation operation)

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

getMappingComparator, getMappingPathPatterns, getMatchingMapping, handleMatch, handleNoMatch

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

afterPropertiesSet, createHandlerMethod, detectHandlerMethods, getCorsConfiguration, getHandlerInternal, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, lookupHandlerMethod, registerHandlerMethod, registerMapping, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, unregisterMapping

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

adaptInterceptor, detectMappedInterceptors, getAdaptedInterceptors, getCorsConfigurations, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getUrlPathHelper, initApplicationContext, initInterceptors, setAlwaysUseFullPath, setCorsConfigurations, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper

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

Constructor Detail

AbstractWebMvcEndpointHandlerMapping

public AbstractWebMvcEndpointHandlerMapping(EndpointMapping endpointMapping,
                                            Collection<EndpointInfo<WebOperation>> collection,
                                            EndpointMediaTypes endpointMediaTypes)

Creates a new WebEndpointHandlerMapping that provides mappings for the operations of the given webEndpoints.

Parameters:

endpointMapping - the base mapping for all endpoints

collection - the web endpoints operations

endpointMediaTypes - media types consumed and produced by the endpoints

AbstractWebMvcEndpointHandlerMapping

public AbstractWebMvcEndpointHandlerMapping(EndpointMapping endpointMapping,
                                            Collection<EndpointInfo<WebOperation>> webEndpoints,
                                            EndpointMediaTypes endpointMediaTypes,
                                            org.springframework.web.cors.CorsConfiguration corsConfiguration)

Creates a new WebEndpointHandlerMapping that provides mappings for the operations of the given webEndpoints.

Parameters:

endpointMapping - the base mapping for all endpoints

webEndpoints - the web endpoints

endpointMediaTypes - media types consumed and produced by the endpoints

corsConfiguration - the CORS configuration for the endpoints

Method Detail

getEndpoints

public Collection<EndpointInfo<WebOperation>> getEndpoints()

getEndpointMapping

public EndpointMapping getEndpointMapping()

initHandlerMethods

protected void initHandlerMethods()

Overrides:

initHandlerMethods in class org.springframework.web.servlet.handler.AbstractHandlerMethodMapping<org.springframework.web.servlet.mvc.method.RequestMappingInfo>

initCorsConfiguration

protected org.springframework.web.cors.CorsConfiguration initCorsConfiguration(Object handler,
                                                                               Method method,
                                                                               org.springframework.web.servlet.mvc.method.RequestMappingInfo mapping)

Overrides:

initCorsConfiguration in class org.springframework.web.servlet.handler.AbstractHandlerMethodMapping<org.springframework.web.servlet.mvc.method.RequestMappingInfo>

getLinks

protected abstract Method getLinks()

registerMappingForOperation

protected abstract void registerMappingForOperation(WebOperation operation)

createRequestMappingInfo

protected org.springframework.web.servlet.mvc.method.RequestMappingInfo createRequestMappingInfo(WebOperation operationInfo)

isHandler

protected boolean isHandler(Class<?> beanType)

Specified by:

isHandler in class org.springframework.web.servlet.handler.AbstractHandlerMethodMapping<org.springframework.web.servlet.mvc.method.RequestMappingInfo>

getMappingForMethod

protected org.springframework.web.servlet.mvc.method.RequestMappingInfo getMappingForMethod(Method method,
                                                                                            Class<?> handlerType)

Specified by:

getMappingForMethod in class org.springframework.web.servlet.handler.AbstractHandlerMethodMapping<org.springframework.web.servlet.mvc.method.RequestMappingInfo>

extendInterceptors

protected void extendInterceptors(List<Object> interceptors)

Overrides:

extendInterceptors in class org.springframework.web.servlet.handler.AbstractHandlerMapping