AbstractUrlHandlerMapping (Spring Framework) - Spring Framework 1.2.9 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.web.servlet.handler
Class 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

All Implemented Interfaces:: ApplicationContextAware, Ordered, HandlerMapping

Direct Known Subclasses:: AbstractPathMapHandlerMapping, BeanNameUrlHandlerMapping, SimpleUrlHandlerMapping

public abstract class AbstractUrlHandlerMapping
extends AbstractHandlerMapping
extends AbstractHandlerMapping

Abstract base class for URL-mapped HandlerMapping implementations. Provides infrastructure for mapping handlers to URLs and configurable URL lookup. For information on the latter, see "alwaysUseFullPath" property.

Supports direct matches, e.g. a registered "/test" matches "/test", and various Ant-style pattern matches, e.g. a registered "/t*" pattern matches both "/test" and "/team", "/test/*" matches all paths in the "/test" directory, "/test/**" matches all paths below "/test". For details, see the AntPathMatcher javadoc.

Will search all path patterns to find the most exact match for the current request path. The most exact match is defined as the longest path pattern that matches the current request path.

Since:: 16.04.2003
Author:: Juergen Hoeller
See Also:: setAlwaysUseFullPath(boolean), setUrlDecode(boolean), AntPathMatcher

Field Summary

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

AbstractUrlHandlerMapping()


Method Summary

protected Object getHandlerInternal(HttpServletRequest request)
          Look up a handler for the URL path of the given request.

Map 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.

protected Object lookupHandler(String urlPath)
          Look up a handler instance for the given URL path.

protected 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 setPathMatcher(PathMatcher pathMatcher)
          Set the PathMatcher implementation to use for matching URL paths against registered URL patterns.

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.

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

getDefaultHandler, getHandler, getOrder, setDefaultHandler, setInterceptors, setOrder

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, isContextRequired

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
`logger`

Constructor Summary
`AbstractUrlHandlerMapping()`

Method Summary
`protected Object`	`getHandlerInternal(HttpServletRequest request)` Look up a handler for the URL path of the given request.
`Map`	`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.
`protected Object`	`lookupHandler(String urlPath)` Look up a handler instance for the given URL path.
`protected 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`	`setPathMatcher(PathMatcher pathMatcher)` Set the PathMatcher implementation to use for matching URL paths against registered URL patterns.
`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.

Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping
`getDefaultHandler, getHandler, getOrder, setDefaultHandler, setInterceptors, setOrder`

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport
`getServletContext, getTempDir, getWebApplicationContext, isContextRequired`

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
`getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

AbstractUrlHandlerMapping

public AbstractUrlHandlerMapping()

Method Detail

setAlwaysUseFullPath

public void setAlwaysUseFullPath(boolean alwaysUseFullPath)

Set if URL lookup should always use the full path within the current servlet context. Else, the path within the current servlet mapping is used if applicable (that is, in the case of a ".../*" servlet mapping in web.xml).

Default is "false".

See Also:: UrlPathHelper.setAlwaysUseFullPath(boolean)

setUrlDecode

public void setUrlDecode(boolean urlDecode)

Set if context path and request URI should be URL-decoded. Both are returned undecoded by the Servlet API, in contrast to the servlet path.

Uses either the request encoding or the default encoding according to the Servlet spec (ISO-8859-1).

Note: Setting this to "true" requires JDK 1.4 if the encoding differs from the VM's platform default encoding, as JDK 1.3's URLDecoder class does not offer a way to specify the encoding.

See Also:: UrlPathHelper.setUrlDecode(boolean)

setUrlPathHelper

public void setUrlPathHelper(UrlPathHelper urlPathHelper)

Set the UrlPathHelper to use for resolution of lookup paths.

Use this to override the default UrlPathHelper with a custom subclass, or to share common UrlPathHelper settings across multiple HandlerMappings and MethodNameResolvers.

See Also:: AbstractUrlMethodNameResolver.setUrlPathHelper(org.springframework.web.util.UrlPathHelper)

setPathMatcher

public void setPathMatcher(PathMatcher pathMatcher)

Set the PathMatcher implementation to use for matching URL paths against registered URL patterns. Default is AntPathMatcher.

See Also:: AntPathMatcher

setLazyInitHandlers

public void setLazyInitHandlers(boolean lazyInitHandlers)

Set whether to lazily initialize handlers. Only applicable to singleton handlers, as prototypes are always lazily initialized. Default is "false", as eager initialization allows for more efficiency through referencing the controller objects directly.

If you want to allow your controllers to be lazily initialized, make them "lazy-init" and set this flag to true. Just making them "lazy-init" will not work, as they are initialized through the references from the handler mapping in this case.

getHandlerInternal

protected Object getHandlerInternal(HttpServletRequest request)
                             throws Exception

Look up a handler for the URL path of the given request.

Specified by:: getHandlerInternal in class AbstractHandlerMapping

Parameters:: request - current HTTP request
Returns:: the handler instance, or null if none found
Throws:: Exception - if there is an internal error

lookupHandler

protected Object lookupHandler(String urlPath)

Look up a handler instance for the given URL path.

Supports direct matches, e.g. a registered "/test" matches "/test", and various Ant-style pattern matches, e.g. a registered "/t*" matches both "/test" and "/team". For details, see the AntPathMatcher class.

Looks for the most exact pattern, where most exact is defined as the longest path pattern.

Parameters:: urlPath - URL the bean is mapped to
Returns:: the associated handler instance, or null if not found
See Also:: AntPathMatcher

registerHandler

protected void registerHandler(String urlPath,
                               Object handler)
                        throws BeansException

Parameters:: urlPath - the URL the bean should be mapped to; handler - the handler instance or handler bean name String (a bean name will automatically be resolved into the corrresponding handler bean)
Throws:: BeansException - if the handler couldn't be registered

getHandlerMap

public final Map 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.

See Also:: AbstractHandlerMapping.getDefaultHandler()