public abstract class

AbstractControllerUrlHandlerMapping

extends AbstractDetectingUrlHandlerMapping

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
					↳	org.springframework.web.servlet.mvc.support.AbstractControllerUrlHandlerMapping

Known Direct Subclasses

ControllerBeanNameHandlerMapping, ControllerClassNameHandlerMapping

Class Overview

Base class for HandlerMapping implementations that derive URL paths according to conventions for specific controller types.

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
	AbstractControllerUrlHandlerMapping()

Public Methods
void	setExcludedClasses(Class[] excludedClasses) Specify controller classes that should be excluded from this mapping.
void	setExcludedPackages(String[] excludedPackages) Specify Java packages that should be excluded from this mapping.
void	setIncludeAnnotatedControllers(boolean includeAnnotatedControllers) Set whether to activate or deactivate detection of annotated controllers.

Protected Methods
abstract String[]	buildUrlsForHandler(String beanName, Class beanClass) Abstract template method to be implemented by subclasses.
String[]	determineUrlsForHandler(String beanName) This implementation delegates to `buildUrlsForHandler(String, Class)`, provided that `isEligibleForMapping(String, Class)` returns `true`.
boolean	isControllerType(Class beanClass) Determine whether the given bean class indicates a controller type that is supported by this mapping strategy.
boolean	isEligibleForMapping(String beanName, Class beanClass) Determine whether the specified controller is excluded from this mapping.
boolean	isMultiActionControllerType(Class beanClass) Determine whether the given bean class indicates a controller type that dispatches to multiple action methods.

[Expand]

Inherited Methods

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

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 AbstractControllerUrlHandlerMapping ()

Public Methods

public void setExcludedClasses (Class[] excludedClasses)

Specify controller classes that should be excluded from this mapping. Any such classes will simply be ignored by this HandlerMapping.

public void setExcludedPackages (String[] excludedPackages)

Specify Java packages that should be excluded from this mapping. Any classes in such a package (or any of its subpackages) will be ignored by this HandlerMapping.

Default is to exclude the entire "org.springframework.web.servlet.mvc" package, including its subpackages, since none of Spring's out-of-the-box Controller implementations is a reasonable candidate for this mapping strategy. Such controllers are typically handled by a separate HandlerMapping, e.g. a BeanNameUrlHandlerMapping, alongside this ControllerClassNameHandlerMapping for application controllers.

public void setIncludeAnnotatedControllers (boolean includeAnnotatedControllers)

Set whether to activate or deactivate detection of annotated controllers.

Protected Methods

protected abstract String[] buildUrlsForHandler (String beanName, Class beanClass)

Abstract template method to be implemented by subclasses.

Parameters

beanName	the name of the bean
beanClass	the type of the bean

Returns

the URLs determined for the bean

protected String[] determineUrlsForHandler (String beanName)

This implementation delegates to buildUrlsForHandler(String, Class), provided that isEligibleForMapping(String, Class) returns true.

Parameters

beanName	the name of the candidate bean

Returns

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

protected boolean isControllerType (Class beanClass)

Determine whether the given bean class indicates a controller type that is supported by this mapping strategy.

Parameters

beanClass	the class to introspect

protected boolean isEligibleForMapping (String beanName, Class beanClass)

Determine whether the specified controller is excluded from this mapping.

Parameters

beanName	the name of the controller bean
beanClass	the concrete class of the controller bean

Returns

whether the specified class is excluded

protected boolean isMultiActionControllerType (Class beanClass)

Determine whether the given bean class indicates a controller type that dispatches to multiple action methods.

Parameters

beanClass	the class to introspect

Classes

AbstractControllerUrlHandlerMapping

Class Overview

See Also

Summary

Public Constructors

public AbstractControllerUrlHandlerMapping ()

Public Methods

public void setExcludedClasses (Class[] excludedClasses)

public void setExcludedPackages (String[] excludedPackages)

public void setIncludeAnnotatedControllers (boolean includeAnnotatedControllers)

Protected Methods

protected abstract String[] buildUrlsForHandler (String beanName, Class beanClass)

Parameters

Returns

protected String[] determineUrlsForHandler (String beanName)

Parameters

Returns

protected boolean isControllerType (Class beanClass)

Parameters

protected boolean isEligibleForMapping (String beanName, Class beanClass)

Parameters

Returns

See Also

protected boolean isMultiActionControllerType (Class beanClass)

Parameters