org.springframework.boot.actuate.endpoint.mvc

Class EndpointHandlerMapping

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.mvc.AbstractEndpointHandlerMapping<MvcEndpoint>

org.springframework.boot.actuate.endpoint.mvc.EndpointHandlerMapping

All Implemented Interfaces:

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

public class EndpointHandlerMapping
extends AbstractEndpointHandlerMapping<MvcEndpoint>

HandlerMapping to map Endpoints to URLs via Endpoint.getId(). The semantics of @RequestMapping should be identical to a normal @Controller, but the endpoints should not be annotated as @Controller (otherwise they will be mapped by the normal MVC mechanisms).

One of the aims of the mapping is to support endpoints that work as HTTP endpoints but can still provide useful service interfaces when there is no HTTP server (and no Spring MVC on the classpath). Note that any endpoints having method signatures will break in a non-servlet environment.

Author:

Phillip Webb, Christian Dupuis, Dave Syer

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, 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
EndpointHandlerMapping(Collection<? extends MvcEndpoint> endpoints) Create a new EndpointHandlerMapping instance.
EndpointHandlerMapping(Collection<? extends MvcEndpoint> endpoints, CorsConfiguration corsConfiguration) Create a new EndpointHandlerMapping instance.

Method Summary

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

afterPropertiesSet, extendInterceptors, getCorsHandlerExecutionChain, getEndpoints, getHandlerExecutionChain, getPath, getPath, getPrefix, initCorsConfiguration, isDisabled, isHandler, postProcessEndpoints, registerHandlerMethod, setDisabled, setPrefix, setSecurityInterceptor

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

createRequestMappingInfo, getContentNegotiationManager, getCustomMethodCondition, getCustomTypeCondition, getFileExtensions, getMappingForMethod, match, resolveEmbeddedValuesInPatterns, setContentNegotiationManager, setEmbeddedValueResolver, setUseRegisteredSuffixPatternMatch, setUseSuffixPatternMatch, setUseTrailingSlashMatch, useRegisteredSuffixPatternMatch, useSuffixPatternMatch, useTrailingSlashMatch

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

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

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

adaptInterceptor, detectMappedInterceptors, getAdaptedInterceptors, getCorsConfigurations, getCorsProcessor, getDefaultHandler, getHandler, 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, 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.HandlerMapping

getHandler

Constructor Detail

EndpointHandlerMapping

public EndpointHandlerMapping(Collection<? extends MvcEndpoint> endpoints)

Create a new EndpointHandlerMapping instance. All Endpoints will be detected from the ApplicationContext. The endpoints will not accept CORS requests.

Parameters:

endpoints - the endpoints

EndpointHandlerMapping

public EndpointHandlerMapping(Collection<? extends MvcEndpoint> endpoints,
                              CorsConfiguration corsConfiguration)

Create a new EndpointHandlerMapping instance. All Endpoints will be detected from the ApplicationContext. The endpoints will accepts CORS requests based on the given corsConfiguration.

Parameters:

endpoints - the endpoints

corsConfiguration - the CORS configuration for the endpoints

Since:

1.3.0