001/* 002 * Copyright 2002-2016 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 * https://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 017package org.springframework.web.servlet.handler; 018 019import javax.servlet.http.HttpServletRequest; 020 021import org.springframework.lang.Nullable; 022import org.springframework.web.servlet.HandlerMapping; 023 024/** 025 * Additional interface that a {@link HandlerMapping} can implement to expose 026 * a request matching API aligned with its internal request matching 027 * configuration and implementation. 028 * 029 * @author Rossen Stoyanchev 030 * @since 4.3.1 031 * @see HandlerMappingIntrospector 032 */ 033public interface MatchableHandlerMapping extends HandlerMapping { 034 035 /** 036 * Determine whether the given request matches the request criteria. 037 * @param request the current request 038 * @param pattern the pattern to match 039 * @return the result from request matching, or {@code null} if none 040 */ 041 @Nullable 042 RequestMatchResult match(HttpServletRequest request, String pattern); 043 044}