root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Merge branch '6.0.x'

This commit is contained in:
Sam Brannen 2023-05-25 13:48:15 +02:00
parent f91fae5dfb cfb3a45479
commit 01abd521e2
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ExchangeFilterFunction.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2021 the original author or authors. * Copyright 2002-2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -24,6 +24,7 @@ import org.springframework.util.Assert;
/** /**
* Represents a function that filters an {@linkplain ExchangeFunction exchange function}. * Represents a function that filters an {@linkplain ExchangeFunction exchange function}.
*
* <p>The filter is executed when a {@code Subscriber} subscribes to the * <p>The filter is executed when a {@code Subscriber} subscribes to the
* {@code Publisher} returned by the {@code WebClient}. * {@code Publisher} returned by the {@code WebClient}.
* *
@ -35,15 +36,13 @@ public interface ExchangeFilterFunction {
/** /**
* Apply this filter to the given request and exchange function. * Apply this filter to the given request and exchange function.
* <p>The given {@linkplain ExchangeFunction} represents the next entity * <p>The given {@link ExchangeFunction} represents the next entity in the
* in the chain, to be invoked via * chain, to be invoked via {@link ExchangeFunction#exchange} in order to
* {@linkplain ExchangeFunction#exchange(ClientRequest) invoked} in order to * proceed with the exchange, or not invoked to short-circuit the chain.
* proceed with the exchange, or not invoked to shortcut the chain.
*
* <p><strong>Note:</strong> When a filter handles the response after the * <p><strong>Note:</strong> When a filter handles the response after the
* call to {@link ExchangeFunction#exchange}, extra care must be taken to * call to {@code ExchangeFunction.exchange(...)}, extra care must be taken
* always consume its content or otherwise propagate it downstream for * to always consume its content or otherwise propagate it downstream for
* further handling, for example by the {@link WebClient}. Please, see the * further handling, for example by the {@link WebClient}. Please see the
* reference documentation for more details on this. * reference documentation for more details on this.
* @param request the current request * @param request the current request
* @param next the next exchange function in the chain * @param next the next exchange function in the chain
@ -52,8 +51,8 @@ public interface ExchangeFilterFunction {
Mono<ClientResponse> filter(ClientRequest request, ExchangeFunction next); Mono<ClientResponse> filter(ClientRequest request, ExchangeFunction next);
/** /**
* Return a composed filter function that first applies this filter, and * Return a composed filter function that first applies this filter and
* then applies the given {@code "after"} filter. * then applies the given {@code afterFilter}.
* @param afterFilter the filter to apply after this filter * @param afterFilter the filter to apply after this filter
* @return the composed filter * @return the composed filter
*/ */