1
1
/*
2
- * Copyright 2002-2021 the original author or authors.
2
+ * Copyright 2002-2023 the original author or authors.
3
3
*
4
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
5
* you may not use this file except in compliance with the License.
24
24
25
25
/**
26
26
* Represents a function that filters an {@linkplain ExchangeFunction exchange function}.
27
+ *
27
28
* <p>The filter is executed when a {@code Subscriber} subscribes to the
28
29
* {@code Publisher} returned by the {@code WebClient}.
29
30
*
@@ -35,15 +36,13 @@ public interface ExchangeFilterFunction {
35
36
36
37
/**
37
38
* Apply this filter to the given request and exchange function.
38
- * <p>The given {@linkplain ExchangeFunction} represents the next entity
39
- * in the chain, to be invoked via
40
- * {@linkplain ExchangeFunction#exchange(ClientRequest) invoked} in order to
41
- * proceed with the exchange, or not invoked to shortcut the chain.
42
- *
39
+ * <p>The given {@link ExchangeFunction} represents the next entity in the
40
+ * chain, to be invoked via {@link ExchangeFunction#exchange} in order to
41
+ * proceed with the exchange, or not invoked to short-circuit the chain.
43
42
* <p><strong>Note:</strong> When a filter handles the response after the
44
- * call to {@link ExchangeFunction# exchange}, extra care must be taken to
45
- * always consume its content or otherwise propagate it downstream for
46
- * further handling, for example by the {@link WebClient}. Please, see the
43
+ * call to {@code ExchangeFunction. exchange(...) }, extra care must be taken
44
+ * to always consume its content or otherwise propagate it downstream for
45
+ * further handling, for example by the {@link WebClient}. Please see the
47
46
* reference documentation for more details on this.
48
47
* @param request the current request
49
48
* @param next the next exchange function in the chain
@@ -52,8 +51,8 @@ public interface ExchangeFilterFunction {
52
51
Mono <ClientResponse > filter (ClientRequest request , ExchangeFunction next );
53
52
54
53
/**
55
- * Return a composed filter function that first applies this filter, and
56
- * then applies the given {@code "after"} filter .
54
+ * Return a composed filter function that first applies this filter and
55
+ * then applies the given {@code afterFilter} .
57
56
* @param afterFilter the filter to apply after this filter
58
57
* @return the composed filter
59
58
*/
0 commit comments