org.springframework.security.web.server.ServerRedirectStrategy 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.security.web.server;
import java.net.URI;
import reactor.core.publisher.Mono;
import org.springframework.web.server.ServerWebExchange;
/**
* A strategy for performing redirects.
*
* @author Rob Winch
* @since 5.0
*/
@FunctionalInterface
public interface ServerRedirectStrategy {
/**
* Performs a redirect based upon the provided {@link ServerWebExchange} and
* {@link URI}
* @param exchange the {@link ServerWebExchange} to use
* @param location the location to redirect to
* @return {@code Mono} to indicate when redirect is complete
*/
Mono sendRedirect(ServerWebExchange exchange, URI location);
}