public abstract class

AbstractDetectingUrlHandlerMapping

extends AbstractUrlHandlerMapping

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.AbstractUrlHandlerMapping
				↳	org.springframework.web.servlet.handler.AbstractDetectingUrlHandlerMapping

Known Direct Subclasses

AbstractControllerUrlHandlerMapping, BeanNameUrlHandlerMapping, DefaultAnnotationHandlerMapping

Known Indirect Subclasses

ControllerBeanNameHandlerMapping, ControllerClassNameHandlerMapping

Class Overview

Abstract implementation of the HandlerMapping interface, detecting URL mappings for handler beans through introspection of all defined beans in the application context.

Summary

[Expand]

Inherited Constants

From interface org.springframework.core.Ordered

[Expand]

Inherited Fields

From class org.springframework.context.support.ApplicationObjectSupport

From interface org.springframework.web.servlet.HandlerMapping

Public Constructors
	AbstractDetectingUrlHandlerMapping()

Public Methods
void	initApplicationContext() Calls the `detectHandlers()` method in addition to the superclass's initialization.
void	setDetectHandlersInAncestorContexts(boolean detectHandlersInAncestorContexts) Set whether to detect handler beans in ancestor ApplicationContexts.

Protected Methods
void	detectHandlers() Register all handlers found in the current ApplicationContext.
abstract String[]	determineUrlsForHandler(String beanName) Determine the URLs for the given handler bean.

[Expand]

Inherited Methods

From class org.springframework.web.servlet.handler.AbstractUrlHandlerMapping

Object	buildPathExposingHandler(Object rawHandler, String bestMatchingPattern, String pathWithinMapping, Map<String, String> uriTemplateVariables) Build a handler object for the given raw handler, exposing the actual handler, the `PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE`, as well as the `URI_TEMPLATE_VARIABLES_ATTRIBUTE` before executing the handler.
void	exposePathWithinMapping(String bestMatchingPattern, String pathWithinMapping, HttpServletRequest request) Expose the path within the current mapping as request attribute.
void	exposeUriTemplateVariables(Map<String, String> uriTemplateVariables, HttpServletRequest request) Expose the URI templates variables as request attribute.
Object	getHandlerInternal(HttpServletRequest request) Look up a handler for the URL path of the given request.
final Map<String, Object>	getHandlerMap() Return the registered handlers as an unmodifiable Map, with the registered path as key and the handler object (or handler bean name in case of a lazy-init handler) as value.
PathMatcher	getPathMatcher() Return the PathMatcher implementation to use for matching URL paths against registered URL patterns.
Object	getRootHandler() Return the root handler for this handler mapping (registered for "/"), or `null` if none.
void	initInterceptors() Initialize the specified interceptors, adapting them where necessary.
Object	lookupHandler(String urlPath, HttpServletRequest request) Look up a handler instance for the given URL path.
void	registerHandler(String[] urlPaths, String beanName) Register the specified handler for the given URL paths.
void	registerHandler(String urlPath, Object handler) Register the specified handler for the given URL path.
void	setAlwaysUseFullPath(boolean alwaysUseFullPath) Set if URL lookup should always use the full path within the current servlet context.
void	setLazyInitHandlers(boolean lazyInitHandlers) Set whether to lazily initialize handlers.
void	setMappedInterceptors(MappedInterceptor[] mappedInterceptors)
void	setPathMatcher(PathMatcher pathMatcher) Set the PathMatcher implementation to use for matching URL paths against registered URL patterns.
void	setRootHandler(Object rootHandler) Set the root handler for this handler mapping, that is, the handler to be registered for the root path ("/").
void	setUrlDecode(boolean urlDecode) Set if context path and request URI should be URL-decoded.
void	setUrlPathHelper(UrlPathHelper urlPathHelper) Set the UrlPathHelper to use for resolution of lookup paths.
boolean	supportsTypeLevelMappings() Indicates whether this handler mapping support type-level mappings.
void	validateHandler(Object handler, HttpServletRequest request) Validate the given handler against the current request.

From class org.springframework.web.servlet.handler.AbstractHandlerMapping

HandlerInterceptor	adaptInterceptor(Object interceptor) Adapt the given interceptor object to the HandlerInterceptor interface.
void	extendInterceptors(List<Object> interceptors) Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (see `setInterceptors(Object[])`).
final HandlerInterceptor[]	getAdaptedInterceptors() Return the adapted interceptors as HandlerInterceptor array.
Object	getDefaultHandler() Return the default handler for this handler mapping, or `null` if none.
final HandlerExecutionChain	getHandler(HttpServletRequest request) Look up a handler for the given request, falling back to the default handler if no specific one is found.
HandlerExecutionChain	getHandlerExecutionChain(Object handler, HttpServletRequest request) Build a HandlerExecutionChain for the given handler, including applicable interceptors.
abstract Object	getHandlerInternal(HttpServletRequest request) Look up a handler for the given request, returning `null` if no specific one is found.
final int	getOrder() Return the order value of this object, with a higher value meaning greater in terms of sorting.
void	initApplicationContext() Initializes the interceptors.
void	initInterceptors() Initialize the specified interceptors, adapting them where necessary.
void	setDefaultHandler(Object defaultHandler) Set the default handler for this handler mapping.
void	setInterceptors(Object[] interceptors) Set the interceptors to apply for all handlers mapped by this handler mapping.
final void	setOrder(int order) Specify the order value for this HandlerMapping bean.

From class org.springframework.web.context.support.WebApplicationObjectSupport

From class org.springframework.context.support.ApplicationObjectSupport

From class java.lang.Object

From interface org.springframework.context.ApplicationContextAware

From interface org.springframework.core.Ordered

From interface org.springframework.web.context.ServletContextAware

From interface org.springframework.web.servlet.HandlerMapping

Public Constructors

public AbstractDetectingUrlHandlerMapping ()

Public Methods

public void initApplicationContext ()

Calls the detectHandlers() method in addition to the superclass's initialization.

Throws

ApplicationContextException

public void setDetectHandlersInAncestorContexts (boolean detectHandlersInAncestorContexts)

Set whether to detect handler beans in ancestor ApplicationContexts.

Default is "false": Only handler beans in the current ApplicationContext will be detected, i.e. only in the context that this HandlerMapping itself is defined in (typically the current DispatcherServlet's context).

Switch this flag on to detect handler beans in ancestor contexts (typically the Spring root WebApplicationContext) as well.

Protected Methods

protected void detectHandlers ()

Register all handlers found in the current ApplicationContext.

The actual URL determination for a handler is up to the concrete determineUrlsForHandler(String) implementation. A bean for which no such URLs could be determined is simply not considered a handler.

Throws

BeansException	if the handler couldn't be registered

protected abstract String[] determineUrlsForHandler (String beanName)

Determine the URLs for the given handler bean.

Parameters

beanName	the name of the candidate bean

Returns

the URLs determined for the bean, or null or an empty array if none

Classes

AbstractDetectingUrlHandlerMapping

Class Overview

See Also

Summary

Public Constructors

public AbstractDetectingUrlHandlerMapping ()

Public Methods

public void initApplicationContext ()

Throws

public void setDetectHandlersInAncestorContexts (boolean detectHandlersInAncestorContexts)

Protected Methods

protected void detectHandlers ()

Throws

See Also

protected abstract String[] determineUrlsForHandler (String beanName)

Parameters

Returns