Open Source Repository

Home /spring/spring-web-servlet-3.0.5 | Repository Home



org/springframework/web/servlet/mvc/multiaction/InternalPathMethodNameResolver.java
/*
 * Copyright 2002-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.servlet.mvc.multiaction;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import org.springframework.web.util.WebUtils;

/**
 * Simple implementation of {@link MethodNameResolver} that maps URL to
 * method name. Although this is the default implementation used by the
 {@link MultiActionController} class (because it requires no configuration),
 * it's bit naive for most applications. In particular, we don't usually
 * want to tie URL to implementation methods.
 *
 <p>Maps the resource name after the last slash, ignoring an extension.
 * E.g. "/foo/bar/baz.html" to "baz", assuming a "/foo/bar/baz.html"
 * controller mapping to the corresponding MultiActionController handler.
 * method. Doesn't support wildcards.
 *
 @author Rod Johnson
 @author Juergen Hoeller
*/
public class InternalPathMethodNameResolver extends AbstractUrlMethodNameResolver {

  private String prefix = "";

  private String suffix = "";

  /** Request URL path String --> method name String */
  private final Map<String, String> methodNameCache = new ConcurrentHashMap<String, String>();


  /**
   * Specify a common prefix for handler method names.
   * Will be prepended to the internal path found in the URL:
   * e.g. internal path "baz", prefix "my" -> method name "mybaz".
   */
  public void setPrefix(String prefix) {
    this.prefix = (prefix != null ? prefix : "");
  }

  /**
   * Return the common prefix for handler method names.
   */
  protected String getPrefix() {
    return this.prefix;
  }

  /**
   * Specify a common suffix for handler method names.
   * Will be appended to the internal path found in the URL:
   * e.g. internal path "baz", suffix "Handler" -> method name "bazHandler".
   */
  public void setSuffix(String suffix) {
    this.suffix = (suffix != null ? suffix : "");
  }

  /**
   * Return the common suffix for handler method names.
   */
  protected String getSuffix() {
    return this.suffix;
  }


  /**
   * Extracts the method name indicated by the URL path.
   @see #extractHandlerMethodNameFromUrlPath
   @see #postProcessHandlerMethodName
   */
  @Override
  protected String getHandlerMethodNameForUrlPath(String urlPath) {
    String methodName = this.methodNameCache.get(urlPath);
    if (methodName == null) {
      methodName = extractHandlerMethodNameFromUrlPath(urlPath);
      methodName = postProcessHandlerMethodName(methodName);
      this.methodNameCache.put(urlPath, methodName);
    }
    return methodName;
  }

  /**
   * Extract the handler method name from the given request URI.
   * Delegates to <code>WebUtils.extractViewNameFromUrlPath(String)</code>.
   @param uri the request URI (e.g. "/index.html")
   @return the extracted URI filename (e.g. "index")
   @see org.springframework.web.util.WebUtils#extractFilenameFromUrlPath
   */
  protected String extractHandlerMethodNameFromUrlPath(String uri) {
    return WebUtils.extractFilenameFromUrlPath(uri);
  }

  /**
   * Build the full handler method name based on the given method name
   * as indicated by the URL path.
   <p>The default implementation simply applies prefix and suffix.
   * This can be overridden, for example, to manipulate upper case
   * / lower case, etc.
   @param methodName the original method name, as indicated by the URL path
   @return the full method name to use
   @see #getPrefix()
   @see #getSuffix()
   */
  protected String postProcessHandlerMethodName(String methodName) {
    return getPrefix() + methodName + getSuffix();
  }

}