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

Class ControllerEndpointHandlerMapping

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.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping

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

All Implemented Interfaces:

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

public class ControllerEndpointHandlerMapping
extends RequestMappingHandlerMapping

HandlerMapping that exposes @ControllerEndpoint and @RestControllerEndpoint annotated endpoints over Spring MVC.

Since:

2.0.0

Author:

Phillip Webb

Field Summary

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

mappingsLogger

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
ControllerEndpointHandlerMapping(EndpointMapping endpointMapping, Collection<ExposableControllerEndpoint> endpoints, CorsConfiguration corsConfiguration) Create a new ControllerEndpointHandlerMapping instance providing mappings for the specified endpoints.

Method Summary

Modifier and Type	Method and Description
protected void	extendInterceptors(List<Object> interceptors)
protected boolean	hasCorsConfigurationSource(Object handler)
protected CorsConfiguration	initCorsConfiguration(Object handler, Method method, RequestMappingInfo mapping)
protected void	initHandlerMethods()
protected void	registerHandlerMethod(Object handler, Method method, RequestMappingInfo mapping)

Methods inherited from class org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping

afterPropertiesSet, createRequestMappingInfo, getBuilderConfiguration, getContentNegotiationManager, getCustomMethodCondition, getCustomTypeCondition, getFileExtensions, getMappingForMethod, getPathPrefixes, isHandler, match, registerMapping, resolveEmbeddedValuesInPatterns, setContentNegotiationManager, setEmbeddedValueResolver, setPathPrefixes, setUseRegisteredSuffixPatternMatch, setUseSuffixPatternMatch, setUseTrailingSlashMatch, useRegisteredSuffixPatternMatch, useSuffixPatternMatch, useTrailingSlashMatch

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

createHandlerMethod, detectHandlerMethods, getCandidateBeanNames, getCorsConfiguration, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, lookupHandlerMethod, processCandidateBean, 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.web.servlet.handler.MatchableHandlerMapping

getPatternParser

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

getHandler, usesPathPatterns

Constructor Detail

ControllerEndpointHandlerMapping

public ControllerEndpointHandlerMapping(EndpointMapping endpointMapping,
                                        Collection<ExposableControllerEndpoint> endpoints,
                                        CorsConfiguration corsConfiguration)

Create a new ControllerEndpointHandlerMapping instance providing mappings for the specified endpoints.

Parameters:

endpointMapping - the base mapping for all endpoints

endpoints - the web endpoints

corsConfiguration - the CORS configuration for the endpoints or null

Method Detail

initHandlerMethods

protected void initHandlerMethods()

Overrides:

initHandlerMethods in class AbstractHandlerMethodMapping<RequestMappingInfo>

registerHandlerMethod

protected void registerHandlerMethod(Object handler,
                                     Method method,
                                     RequestMappingInfo mapping)

Overrides:

registerHandlerMethod in class RequestMappingHandlerMapping

hasCorsConfigurationSource

protected boolean hasCorsConfigurationSource(Object handler)

Overrides:

hasCorsConfigurationSource in class AbstractHandlerMethodMapping<RequestMappingInfo>

initCorsConfiguration

protected CorsConfiguration initCorsConfiguration(Object handler,
                                                  Method method,
                                                  RequestMappingInfo mapping)

Overrides:

initCorsConfiguration in class RequestMappingHandlerMapping

extendInterceptors

protected void extendInterceptors(List<Object> interceptors)

Overrides:

extendInterceptors in class AbstractHandlerMapping