-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathHeaders.java
More file actions
83 lines (79 loc) · 2.06 KB
/
Headers.java
File metadata and controls
83 lines (79 loc) · 2.06 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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/*
* Copyright © 2012 The Feign Authors (feign@commonhaus.dev)
*
* 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;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Expands headers supplied in the {@code value}. Variables to the the right of the colon are
* expanded. <br>
*
* <pre>
* @Headers("Content-Type: application/xml")
* interface SoapApi {
* ...
* @RequestLine("GET /")
* @Headers("Cache-Control: max-age=640000")
* ...
*
* @RequestLine("POST /")
* @Headers({
* "X-Foo: Bar",
* "X-Ping: {token}"
* }) void post(@Param("token") String token);
* ...
* </pre>
*
* <br>
* <strong>Notes:</strong>
*
* <ul>
* <li>If you'd like curly braces literally in the header, urlencode them first.
* <li>Headers do not overwrite each other. All headers with the same name will be included in the
* request.
* </ul>
*
* <br>
* <b>Relationship to JAXRS</b><br>
* <br>
* The following two forms are identical. <br>
* <br>
* Feign:
*
* <pre>
* @RequestLine("POST /")
* @Headers({
* "X-Ping: {token}"
* }) void post(@Named("token") String token);
* ...
* </pre>
*
* <br>
* JAX-RS:
*
* <pre>
* @POST @Path("/")
* void post(@HeaderParam("X-Ping") String token);
* ...
* </pre>
*/
@Target({METHOD, TYPE})
@Retention(RUNTIME)
public @interface Headers {
String[] value();
}