forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRequestInterceptor.java
More file actions
56 lines (54 loc) · 2.08 KB
/
RequestInterceptor.java
File metadata and controls
56 lines (54 loc) · 2.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/**
* Copyright 2012-2020 The Feign 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 feign;
/**
* Zero or more {@code RequestInterceptors} may be configured for purposes such as adding headers to
* all requests. No guarantees are given with regards to the order that interceptors are applied.
* Once interceptors are applied, {@link Target#apply(RequestTemplate)} is called to create the
* immutable http request sent via {@link Client#execute(Request, feign.Request.Options)}. <br>
* <br>
* For example: <br>
*
* <pre>
* public void apply(RequestTemplate input) {
* input.header("X-Auth", currentToken);
* }
* </pre>
*
* <br>
* <br>
* <b>Configuration</b><br>
* <br>
* {@code RequestInterceptors} are configured via {@link Feign.Builder#requestInterceptors}. <br>
* <br>
* <b>Implementation notes</b><br>
* <br>
* Do not add parameters, such as {@code /path/{foo}/bar } in your implementation of
* {@link #apply(RequestTemplate)}. <br>
* Interceptors are applied after the template's parameters are
* {@link RequestTemplate#resolve(java.util.Map) resolved}. This is to ensure that you can implement
* signatures are interceptors. <br>
* <br>
* <br>
* <b>Relationship to Retrofit 1.x</b><br>
* <br>
* This class is similar to {@code RequestInterceptor.intercept()}, except that the implementation
* can read, remove, or otherwise mutate any part of the request template.
*/
public interface RequestInterceptor {
/**
* Called for every request. Add data using methods on the supplied {@link RequestTemplate}.
*/
void apply(RequestTemplate template);
}