BeanNameUrlHandlerMapping

Class Overview

Implementation of the HandlerMapping interface that map from URLs to beans with names that start with a slash ("/"), similar to how Struts maps URLs to action names.

This is the default implementation used by the DispatcherServlet, along with DefaultAnnotationHandlerMapping (on Java 5 and higher). Alternatively, SimpleUrlHandlerMapping allows for customizing a handler mapping declaratively.

The mapping is from URL to bean name. Thus an incoming URL "/foo" would map to a handler named "/foo", or to "/foo /foo2" in case of multiple mappings to a single handler. Note: In XML definitions, you'll need to use an alias name="/foo" in the bean definition, as the XML id may not contain slashes.

Supports direct matches (given "/test" -> registered "/test") and "*" matches (given "/test" -> registered "/t*"). Note that the default is to map within the current servlet mapping if applicable; see the "alwaysUseFullPath" property for details. For details on the pattern options, see the AntPathMatcher javadoc.

Summary

[Expand] Inherited Constants
From interface org.springframework.core.Ordered int HIGHEST_PRECEDENCE Useful constant for the highest precedence value. int LOWEST_PRECEDENCE Useful constant for the lowest precedence value.

[Expand] Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport protected final Log logger Logger that is available to subclasses
From interface org.springframework.web.servlet.HandlerMapping public static final String BEST_MATCHING_PATTERN_ATTRIBUTE Name of the HttpServletRequest attribute that contains the best matching pattern within the handler mapping. public static final String INTROSPECT_TYPE_LEVEL_MAPPING Name of the boolean HttpServletRequest attribute that indicates whether type-level mappings should be inspected. public static final String PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE Name of the HttpServletRequest attribute that contains the path within the handler mapping, in case of a pattern match, or the full relevant URI (typically within the DispatcherServlet's mapping) else. public static final String URI_TEMPLATE_VARIABLES_ATTRIBUTE Name of the HttpServletRequest attribute that contains the URI templates map, mapping variable names to values.

[Expand] Inherited Methods
From class org.springframework.web.servlet.handler.AbstractDetectingUrlHandlerMapping void detectHandlers() Register all handlers found in the current ApplicationContext. abstract String[] determineUrlsForHandler(String beanName) Determine the URLs for the given handler bean. 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.
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 final ServletContext getServletContext() Return the current ServletContext. final File getTempDir() Return the temporary directory for the current web application, as provided by the servlet container. final WebApplicationContext getWebApplicationContext() Return the current application context as WebApplicationContext. void initApplicationContext(ApplicationContext context) Calls initServletContext(javax.servlet.ServletContext) if the given ApplicationContext is a WebApplicationContext. void initServletContext(ServletContext servletContext) Subclasses may override this for custom initialization based on the ServletContext that this application object runs in. boolean isContextRequired() Overrides the base class behavior to enforce running in an ApplicationContext. final void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From class org.springframework.context.support.ApplicationObjectSupport final ApplicationContext getApplicationContext() Return the ApplicationContext that this object is associated with. final MessageSourceAccessor getMessageSourceAccessor() Return a MessageSourceAccessor for the application context used by this object, for easy message access. void initApplicationContext() Subclasses can override this for custom initialization behavior. void initApplicationContext(ApplicationContext context) Subclasses can override this for custom initialization behavior. boolean isContextRequired() Determine whether this application object needs to run in an ApplicationContext. Class requiredContextClass() Determine the context class that any context passed to setApplicationContext must be an instance of. final void setApplicationContext(ApplicationContext context) Set the ApplicationContext that this object runs in.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.context.ApplicationContextAware abstract void setApplicationContext(ApplicationContext applicationContext) Set the ApplicationContext that this object runs in.
From interface org.springframework.core.Ordered abstract int getOrder() Return the order value of this object, with a higher value meaning greater in terms of sorting.
From interface org.springframework.web.context.ServletContextAware abstract void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From interface org.springframework.web.servlet.HandlerMapping abstract HandlerExecutionChain getHandler(HttpServletRequest request) Return a handler and any interceptors for this request.