org.springframework.web.servlet.mvc.condition.RequestCondition.java Source code

Introduction

Here is the source code for org.springframework.web.servlet.mvc.condition.RequestCondition.java

Source

/*
 * 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
 *
 *      https://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.condition;

import javax.servlet.http.HttpServletRequest;

import org.springframework.lang.Nullable;

/**
 * Contract for request mapping conditions.
 *
 * <p>Request conditions can be combined via {@link #combine(Object)}, matched to
 * a request via {@link #getMatchingCondition(HttpServletRequest)}, and compared
 * to each other via {@link #compareTo(Object, HttpServletRequest)} to determine
 * which is a closer match for a given request.
 *
 * @author Rossen Stoyanchev
 * @author Arjen Poutsma
 * @since 3.1
 * @param <T> the type of objects that this RequestCondition can be combined
 * with and compared to
 */
public interface RequestCondition<T> {

    /**
     * Combine this condition with another such as conditions from a
     * type-level and method-level {@code @RequestMapping} annotation.
     * @param other the condition to combine with.
     * @return a request condition instance that is the result of combining
     * the two condition instances.
     */
    T combine(T other);

    /**
     * Check if the condition matches the request returning a potentially new
     * instance created for the current request. For example a condition with
     * multiple URL patterns may return a new instance only with those patterns
     * that match the request.
     * <p>For CORS pre-flight requests, conditions should match to the would-be,
     * actual request (e.g. URL pattern, query parameters, and the HTTP method
     * from the "Access-Control-Request-Method" header). If a condition cannot
     * be matched to a pre-flight request it should return an instance with
     * empty content thus not causing a failure to match.
     * @return a condition instance in case of a match or {@code null} otherwise.
     */
    @Nullable
    T getMatchingCondition(HttpServletRequest request);

    /**
     * Compare this condition to another condition in the context of
     * a specific request. This method assumes both instances have
     * been obtained via {@link #getMatchingCondition(HttpServletRequest)}
     * to ensure they have content relevant to current request only.
     */
    int compareTo(T other, HttpServletRequest request);

}