forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathEncoder.java
More file actions
84 lines (80 loc) · 2.53 KB
/
Encoder.java
File metadata and controls
84 lines (80 loc) · 2.53 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
84
/*
* Copyright 2013 Netflix, Inc.
*
* 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.codec;
import feign.RequestTemplate;
import static java.lang.String.format;
/**
* Encodes an object into an HTTP request body. Like {@code javax.websocket.Encoder}.
* {@code Encoder} is used when a method parameter has no {@code @Param} annotation.
* For example: <br>
* <p/>
* <pre>
* @POST
* @Path("/")
* void create(User user);
* </pre>
* Example implementation: <br>
* <p/>
* <pre>
* public class GsonEncoder implements Encoder {
* private final Gson gson;
*
* public GsonEncoder(Gson gson) {
* this.gson = gson;
* }
*
* @Override
* public void encode(Object object, RequestTemplate template) {
* template.body(gson.toJson(object));
* }
* }
* </pre>
*
* <p/>
* <h3>Form encoding</h3>
* <br>
* If any parameters are found in {@link feign.MethodMetadata#formParams()}, they will be
* collected and passed to the Encoder as a {@code Map<String, ?>}.
* <br>
* <pre>
* @POST
* @Path("/")
* Session login(@Named("username") String username, @Named("password") String password);
* </pre>
*/
public interface Encoder {
/**
* Converts objects to an appropriate representation in the template.
*
* @param object what to encode as the request body.
* @param template the request template to populate.
* @throws EncodeException when encoding failed due to a checked exception.
*/
void encode(Object object, RequestTemplate template) throws EncodeException;
/**
* Default implementation of {@code Encoder} that supports {@code String}s only.
*/
public class Default implements Encoder {
@Override
public void encode(Object object, RequestTemplate template) throws EncodeException {
if (object instanceof String) {
template.body(object.toString());
} else if (object != null) {
throw new EncodeException(format("%s is not a type supported by this encoder.", object.getClass()));
}
}
}
}