001: /*
002: * Copyright 2002-2005 the original author or authors.
003: *
004: * Licensed under the Apache License, Version 2.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.apache.org/licenses/LICENSE-2.0
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016:
017: package org.springframework.web.servlet.mvc.multiaction;
018:
019: import javax.servlet.http.HttpServletRequest;
020:
021: import org.apache.commons.logging.Log;
022: import org.apache.commons.logging.LogFactory;
023:
024: import org.springframework.web.util.UrlPathHelper;
025:
026: /**
027: * Abstract base class for URL-based MethodNameResolver implementations.
028: *
029: * <p>Provides infrastructure for mapping handlers to URLs and configurable
030: * URL lookup. For information on the latter, see <code>alwaysUseFullPath</code>
031: * and <code>urlDecode</code> properties.
032: *
033: * @author Juergen Hoeller
034: * @since 14.01.2004
035: * @see #setAlwaysUseFullPath
036: * @see #setUrlDecode
037: */
038: public abstract class AbstractUrlMethodNameResolver implements
039: MethodNameResolver {
040:
041: /** Logger available to subclasses */
042: protected final Log logger = LogFactory.getLog(getClass());
043:
044: private UrlPathHelper urlPathHelper = new UrlPathHelper();
045:
046: /**
047: * Set if URL lookup should always use full path within current servlet
048: * context. Else, the path within the current servlet mapping is used
049: * if applicable (i.e. in the case of a ".../*" servlet mapping in web.xml).
050: * Default is "false".
051: * @see org.springframework.web.util.UrlPathHelper#setAlwaysUseFullPath
052: */
053: public void setAlwaysUseFullPath(boolean alwaysUseFullPath) {
054: this .urlPathHelper.setAlwaysUseFullPath(alwaysUseFullPath);
055: }
056:
057: /**
058: * Set if context path and request URI should be URL-decoded.
059: * Both are returned <i>undecoded</i> by the Servlet API,
060: * in contrast to the servlet path.
061: * <p>Uses either the request encoding or the default encoding according
062: * to the Servlet spec (ISO-8859-1).
063: * <p>Note: Setting this to "true" requires JDK 1.4 if the encoding differs
064: * from the VM's platform default encoding, as JDK 1.3's URLDecoder class
065: * does not offer a way to specify the encoding.
066: * @see org.springframework.web.util.UrlPathHelper#setUrlDecode
067: */
068: public void setUrlDecode(boolean urlDecode) {
069: this .urlPathHelper.setUrlDecode(urlDecode);
070: }
071:
072: /**
073: * Set the UrlPathHelper to use for resolution of lookup paths.
074: * <p>Use this to override the default UrlPathHelper with a custom subclass,
075: * or to share common UrlPathHelper settings across multiple MethodNameResolvers
076: * and HandlerMappings.
077: * @see org.springframework.web.servlet.handler.AbstractUrlHandlerMapping#setUrlPathHelper
078: */
079: public void setUrlPathHelper(UrlPathHelper urlPathHelper) {
080: this .urlPathHelper = urlPathHelper;
081: }
082:
083: /**
084: * Retrieves the URL path to use for lookup and delegates to
085: * <code>getHandlerMethodNameForUrlPath</code>.
086: * Converts <code>null</code> values to NoSuchRequestHandlingMethodExceptions.
087: * @see #getHandlerMethodNameForUrlPath
088: */
089: public final String getHandlerMethodName(HttpServletRequest request)
090: throws NoSuchRequestHandlingMethodException {
091:
092: String urlPath = this .urlPathHelper
093: .getLookupPathForRequest(request);
094: String name = getHandlerMethodNameForUrlPath(urlPath);
095: if (name == null) {
096: throw new NoSuchRequestHandlingMethodException(request);
097: }
098: if (logger.isDebugEnabled()) {
099: logger.debug("Returning handler method name '" + name
100: + "' for lookup path: " + urlPath);
101: }
102: return name;
103: }
104:
105: /**
106: * Return a method name that can handle this request, based on the
107: * given lookup path. Called by <code>getHandlerMethodName</code>.
108: * @param urlPath the URL path to use for lookup,
109: * according to the settings in this class
110: * @return a method name that can handle this request.
111: * Should return null if no matching method found.
112: * @see #getHandlerMethodName
113: * @see #setAlwaysUseFullPath
114: * @see #setUrlDecode
115: */
116: protected abstract String getHandlerMethodNameForUrlPath(
117: String urlPath);
118:
119: }
|