/*
 * Copyright 2002-2016 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.handler;

import java.util.ArrayList;
import java.util.List;

import org.springframework.util.StringUtils;

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

Author:Rod Johnson, Juergen Hoeller
See Also:
/** * Implementation of the {@link org.springframework.web.servlet.HandlerMapping} * interface that map from URLs to beans with names that start with a slash ("/"), * similar to how Struts maps URLs to action names. * * <p>This is the default implementation used by the * {@link org.springframework.web.servlet.DispatcherServlet}, along with * {@link org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping}. * Alternatively, {@link SimpleUrlHandlerMapping} allows for customizing a * handler mapping declaratively. * * <p>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. * * <p>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 * {@link #setAlwaysUseFullPath "alwaysUseFullPath"} property for details. * For details on the pattern options, see the * {@link org.springframework.util.AntPathMatcher} javadoc. * * @author Rod Johnson * @author Juergen Hoeller * @see SimpleUrlHandlerMapping */
public class BeanNameUrlHandlerMapping extends AbstractDetectingUrlHandlerMapping {
Checks name and aliases of the given bean for URLs, starting with "/".
/** * Checks name and aliases of the given bean for URLs, starting with "/". */
@Override protected String[] determineUrlsForHandler(String beanName) { List<String> urls = new ArrayList<>(); if (beanName.startsWith("/")) { urls.add(beanName); } String[] aliases = obtainApplicationContext().getAliases(beanName); for (String alias : aliases) { if (alias.startsWith("/")) { urls.add(alias); } } return StringUtils.toStringArray(urls); } }