org.springframework.web.cors.reactive.CorsProcessor Maven / Gradle / Ivy
/*
* Copyright 2002-2017 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.cors.reactive;
import org.springframework.lang.Nullable;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.server.ServerWebExchange;
/**
* A strategy to apply CORS validation checks and updates to a
* {@link ServerWebExchange}, either rejecting through the response or adding
* CORS related headers, based on a pre-selected {@link CorsConfiguration}.
*
* @author Sebastien Deleuze
* @author Rossen Stoyanchev
* @since 5.0
* @see CORS W3C recommendation
*/
public interface CorsProcessor {
/**
* Process a request using the given {@code CorsConfiguration}.
* @param configuration the CORS configuration to use; possibly {@code null}
* in which case pre-flight requests are rejected, but all others allowed.
* @param exchange the current exchange
* @return {@code false} if the request was rejected, {@code true} otherwise
*/
boolean process(@Nullable CorsConfiguration configuration, ServerWebExchange exchange);
}