public class

ControllerClassNameHandlerMapping

extends AbstractControllerUrlHandlerMapping

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

Class Overview

Implementation of HandlerMapping that follows a simple convention for generating URL path mappings from the class names of registered Controller beans as well as @Controller annotated beans.

For simple Controller implementations (those that handle a single request type), the convention is to take the short name of the Class, remove the 'Controller' suffix if it exists and return the remaining text, lower-cased, as the mapping, with a leading /. For example:

WelcomeController -> /welcome*
HomeController -> /home*

For MultiActionControllers and @Controller beans, a similar mapping is registered, except that all sub-paths are registered using the trailing wildcard pattern /*. For example:

WelcomeController -> /welcome, /welcome/*
CatalogController -> /catalog, /catalog/*

For MultiActionController it is often useful to use this mapping strategy in conjunction with the InternalPathMethodNameResolver.

Thanks to Warren Oliver for suggesting the "caseSensitive", "pathPrefix" and "basePackage" properties which have been added in Spring 2.5.

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

Public Methods
void	setBasePackage(String basePackage) Set the base package to be used for generating path mappings, including all subpackages underneath this packages as path elements.
void	setCaseSensitive(boolean caseSensitive) Set whether to apply case sensitivity to the generated paths, e.g.
void	setPathPrefix(String prefixPath) Specify a prefix to prepend to the path generated from the controller name.

Protected Methods
String[]	buildUrlsForHandler(String beanName, Class beanClass) Abstract template method to be implemented by subclasses.
String[]	generatePathMappings(Class beanClass) Generate the actual URL paths for the given controller class.

[Expand]

Inherited Methods

From class org.springframework.web.servlet.mvc.support.AbstractControllerUrlHandlerMapping

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

Public Methods

public void setBasePackage (String basePackage)

Set the base package to be used for generating path mappings, including all subpackages underneath this packages as path elements.

Default is null, using the short class name for the generated path, with the controller's package not represented in the path. Specify a base package like "com.mycompany.myapp" to include subpackages within that base package as path elements, e.g. generating the path "/mymodule/buyform" for the class name "com.mycompany.myapp.mymodule.BuyForm". Subpackage hierarchies are represented as individual path elements, e.g. "/mymodule/mysubmodule/buyform" for the class name "com.mycompany.myapp.mymodule.mysubmodule.BuyForm".

public void setCaseSensitive (boolean caseSensitive)

Set whether to apply case sensitivity to the generated paths, e.g. turning the class name "BuyForm" into "buyForm".

Default is "false", using pure lower case paths, e.g. turning the class name "BuyForm" into "buyform".

public void setPathPrefix (String prefixPath)

Specify a prefix to prepend to the path generated from the controller name.

Default is a plain slash ("/"). A path like "/mymodule" can be specified in order to have controller path mappings prefixed with that path, e.g. "/mymodule/buyform" instead of "/buyform" for the class name "BuyForm".

Protected Methods

protected 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[] generatePathMappings (Class beanClass)

Generate the actual URL paths for the given controller class.

Subclasses may choose to customize the paths that are generated by overriding this method.

Parameters

beanClass	the controller bean class to generate a mapping for

Returns

the URL path mappings for the given controller

Classes

ControllerClassNameHandlerMapping

Class Overview

See Also

Summary

Public Constructors

public ControllerClassNameHandlerMapping ()

Public Methods

public void setBasePackage (String basePackage)

public void setCaseSensitive (boolean caseSensitive)

public void setPathPrefix (String prefixPath)

Protected Methods

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

Parameters

Returns

protected String[] generatePathMappings (Class beanClass)

Parameters

Returns