/* * 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.reactive.result.condition; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.LinkedHashSet; import java.util.List; import java.util.Set; import org.springframework.http.HttpMethod; import org.springframework.http.server.reactive.ServerHttpRequest; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.cors.reactive.CorsUtils; import org.springframework.web.server.ServerWebExchange; /** * A logical disjunction (' || ') request condition that matches a request * against a set of {@link RequestMethod}s. * * @author Rossen Stoyanchev * @since 5.0 */ public final class RequestMethodsRequestCondition extends AbstractRequestCondition<RequestMethodsRequestCondition> { private static final RequestMethodsRequestCondition HEAD_CONDITION = new RequestMethodsRequestCondition(RequestMethod.HEAD); private final Set<RequestMethod> methods; /** * Create a new instance with the given request methods. * @param requestMethods 0 or more HTTP request methods; * if, 0 the condition will match to every request */ public RequestMethodsRequestCondition(RequestMethod... requestMethods) { this(asList(requestMethods)); } private RequestMethodsRequestCondition(Collection<RequestMethod> requestMethods) { this.methods = Collections.unmodifiableSet(new LinkedHashSet<>(requestMethods)); } private static List<RequestMethod> asList(RequestMethod... requestMethods) { return (requestMethods != null ? Arrays.asList(requestMethods) : Collections.emptyList()); } /** * Returns all {@link RequestMethod}s contained in this condition. */ public Set<RequestMethod> getMethods() { return this.methods; } @Override protected Collection<RequestMethod> getContent() { return this.methods; } @Override protected String getToStringInfix() { return " || "; } /** * Returns a new instance with a union of the HTTP request methods * from "this" and the "other" instance. */ @Override public RequestMethodsRequestCondition combine(RequestMethodsRequestCondition other) { Set<RequestMethod> set = new LinkedHashSet<>(this.methods); set.addAll(other.methods); return new RequestMethodsRequestCondition(set); } /** * Check if any of the HTTP request methods match the given request and * return an instance that contains the matching HTTP request method only. * @param exchange the current exchange * @return the same instance if the condition is empty (unless the request * method is HTTP OPTIONS), a new condition with the matched request method, * or {@code null} if there is no match or the condition is empty and the * request method is OPTIONS. */ @Override public RequestMethodsRequestCondition getMatchingCondition(ServerWebExchange exchange) { if (CorsUtils.isPreFlightRequest(exchange.getRequest())) { return matchPreFlight(exchange.getRequest()); } if (getMethods().isEmpty()) { if (RequestMethod.OPTIONS.name().equals(exchange.getRequest().getMethod().name())) { return null; // No implicit match for OPTIONS (we handle it) } return this; } return matchRequestMethod(exchange.getRequest().getMethod().name()); } /** * On a pre-flight request match to the would-be, actual request. * Hence empty conditions is a match, otherwise try to match to the HTTP * method in the "Access-Control-Request-Method" header. */ private RequestMethodsRequestCondition matchPreFlight(ServerHttpRequest request) { if (getMethods().isEmpty()) { return this; } HttpMethod expectedMethod = request.getHeaders().getAccessControlRequestMethod(); return matchRequestMethod(expectedMethod.name()); } private RequestMethodsRequestCondition matchRequestMethod(String httpMethodValue) { HttpMethod httpMethod = HttpMethod.resolve(httpMethodValue); if (httpMethod != null) { for (RequestMethod method : getMethods()) { if (httpMethod.matches(method.name())) { return new RequestMethodsRequestCondition(method); } } if (httpMethod == HttpMethod.HEAD && getMethods().contains(RequestMethod.GET)) { return HEAD_CONDITION; } } return null; } /** * Returns: * <ul> * <li>0 if the two conditions contain the same number of HTTP request methods * <li>Less than 0 if "this" instance has an HTTP request method but "other" doesn't * <li>Greater than 0 "other" has an HTTP request method but "this" doesn't * </ul> * <p>It is assumed that both instances have been obtained via * {@link #getMatchingCondition(ServerWebExchange)} and therefore each instance * contains the matching HTTP request method only or is otherwise empty. */ @Override public int compareTo(RequestMethodsRequestCondition other, ServerWebExchange exchange) { return (other.methods.size() - this.methods.size()); } }