Rename Body annotation to Content.

gk-brown · gk-brown · commit b840e1faac02 · 2021-02-20T10:45:37.000-05:00
diff --git a/README.md b/README.md
@@ -184,21 +184,21 @@ protected String getKey(String name) { ... }
 For example, given the preceding request, the key with name "contactID" would be "jsmith" and the key with name "addressType" would be "home".
 
 ### Custom Body Content
-The `Body` annotation can be used to associate custom body content with a service method. Annotated methods can access decoded content via the `getBody()` method. For example:
+The `Content` annotation can be used to associate custom body content with a service method. Annotated methods can access the decoded data via the `getContent()` method. 
+
+For example, the following method might be used to create a new account using data passed in the request body:
 
 ```java
 @RequestMethod("POST")
-@Body(Content.class)
-public uploadContent() {
-    Content content = getBody();
+@Content(Account.class)
+public createAccount() {
+    Account account = getContent();
 
     ...
 }
 ```
 
-By default, body data is assumed to be JSON. However, subclasses can override the `decodeBody()` method to support other representations.
-
-The decoded body is coerced to the declared type using the `BeanAdapter#adapt()` method, which is discussed in more detail later. If the decoded content cannot be converted to the specified type, an HTTP 415 response will be returned.
+By default, body data is assumed to be JSON. However, subclasses can override the `decodeContent()` method to support other representations. If the provided data cannot be deserialized to the specified type, an HTTP 415 response will be returned.
 
 ### Return Values
 Return values are converted to their JSON equivalents as follows:
@@ -326,7 +326,9 @@ The `WebServiceProxy` class is used to issue API requests to a server. A Swift v
 * `method` - the HTTP method to execute
 * `url` - the URL of the requested resource
 
-Request headers and arguments are specified via the `setHeaders()` and `setArguments()` methods, respectively. Like HTML forms, arguments are submitted either via the query string or in the request body. Arguments for `GET`, `PUT`, and `DELETE` requests are always sent in the query string. `POST` arguments are typically sent in the request body, and may be submitted as either "application/x-www-form-urlencoded" or "multipart/form-data" (specified via the proxy's `setEncoding()` method). However, if a custom body is provided via the `setBody()` method or the request body is generated by a custom request handler (specified via the `setRequestHandler()` method), `POST` arguments will be sent in the query string.
+Request headers and arguments are specified via the `setHeaders()` and `setArguments()` methods, respectively. Custom body content can be supplied via the `setContent()` method. 
+
+Like HTML forms, arguments are submitted either via the query string or in the request body. Arguments for `GET`, `PUT`, and `DELETE` requests are always sent in the query string. `POST` arguments are typically sent in the request body, and may be submitted as either "application/x-www-form-urlencoded" or "multipart/form-data" (specified via the proxy's `setEncoding()` method). However, if a custom body is provided either via `setContent()` or by a custom request handler (specified via the `setRequestHandler()` method), `POST` arguments will be sent in the query string.
 
 The `toString()` method is generally used to convert an argument to its string representation. However, `Date` instances are automatically converted to a long value representing epoch time. Additionally, `Iterable` instances represent multi-value parameters and behave similarly to `<select multiple>` tags in HTML. Further, when using the multi-part encoding, `URL` and `Iterable<URL>` values represent file uploads, and behave similarly to `<input type="file">` tags in HTML forms.
 
diff --git a/httprpc-client/src/main/java/org/httprpc/WebServiceProxy.java b/httprpc-client/src/main/java/org/httprpc/WebServiceProxy.java
@@ -226,7 +226,7 @@ public String toString() {
     private Map<String, ?> headers = emptyMap();
     private Map<String, ?> arguments = emptyMap();
 
-    private Object body;
+    private Object content;
 
     private RequestHandler requestHandler = null;
 
@@ -354,23 +354,23 @@ public void setArguments(Map<String, ?> arguments) {
     }
 
     /**
-     * Returns the request body.
+     * Returns the request content.
      *
      * @return
-     * A value representing the request body, or <code>null</code> for no body.
+     * A value representing the request content, or <code>null</code> for no content.
      */
-    public Object getBody() {
-        return body;
+    public Object getContent() {
+        return content;
     }
 
     /**
-     * Returns the request body.
+     * Returns the request content.
      *
-     * @param body
-     * A value representing the request body, or <code>null</code> if no body has been set.
+     * @param content
+     * A value representing the request content, or <code>null</code> if no content has been set.
      */
-    public void setBody(Object body) {
-        this.body = body;
+    public void setContent(Object content) {
+        this.content = content;
     }
 
     /**
@@ -471,7 +471,7 @@ public <T> T invoke() throws IOException {
     public <T> T invoke(ResponseHandler<T> responseHandler) throws IOException {
         URL url;
         RequestHandler requestHandler;
-        if (body != null && this.requestHandler == null) {
+        if (content != null && this.requestHandler == null) {
             url = this.url;
 
             requestHandler = new RequestHandler() {
@@ -484,7 +484,7 @@ public String getContentType() {
                 public void encodeRequest(OutputStream outputStream) throws IOException {
                     JSONEncoder jsonEncoder = new JSONEncoder();
 
-                    jsonEncoder.write(body, outputStream);
+                    jsonEncoder.write(content, outputStream);
                 }
             };
         } else if (method.equalsIgnoreCase("POST") && this.requestHandler == null) {
diff --git a/httprpc-server/src/main/java/org/httprpc/Content.java b/httprpc-server/src/main/java/org/httprpc/Content.java
@@ -6,14 +6,14 @@
 import java.lang.annotation.Target;
 
 /**
- * Annotation that associates a body type with a service method.
+ * Annotation that associates custom body content with a service method.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
-public @interface Body {
+public @interface Content {
     /**
      * @return
-     * The body type.
+     * The content type.
      */
     Class<?> value();
 }
diff --git a/httprpc-server/src/main/java/org/httprpc/WebService.java b/httprpc-server/src/main/java/org/httprpc/WebService.java
@@ -130,7 +130,7 @@ protected URLConnection openConnection(URL url) {
     private ThreadLocal<List<String>> keyList = new ThreadLocal<>();
     private ThreadLocal<Map<String, String>> keyMap = new ThreadLocal<>();
 
-    private ThreadLocal<Object> body = new ThreadLocal<>();
+    private ThreadLocal<Object> content = new ThreadLocal<>();
 
     private static ConcurrentHashMap<Class<?>, WebService> services = new ConcurrentHashMap<>();
 
@@ -367,11 +367,11 @@ protected void service(HttpServletRequest request, HttpServletResponse response)
 
         Object result;
         try {
-            Body body = handler.method.getAnnotation(Body.class);
+            Content content = handler.method.getAnnotation(Content.class);
 
-            if (body != null) {
+            if (content != null) {
                 try {
-                    this.body.set(decodeBody(request, body.value()));
+                    this.content.set(decodeContent(request, content.value()));
                 } catch (Exception exception) {
                     response.setStatus(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE);
                     return;
@@ -421,7 +421,7 @@ protected void service(HttpServletRequest request, HttpServletResponse response)
             this.keyList.set(null);
             this.keyMap.set(null);
 
-            this.body.set(null);
+            this.content.set(null);
         }
 
         if (response.isCommitted()) {
@@ -567,17 +567,17 @@ protected String getKey(String name) {
     }
 
     /**
-     * Returns the body content associated with the current request.
+     * Returns the content associated with the current request.
      *
      * @param <T>
-     * The body type.
+     * The content type.
      *
      * @return
-     * The body content, or <code>null</code> if no body was provided.
+     * The request content, or <code>null</code> if no content was provided.
      */
     @SuppressWarnings("unchecked")
-    protected <T> T getBody() {
-        return (T)body.get();
+    protected <T> T getContent() {
+        return (T)content.get();
     }
 
     /**
@@ -598,21 +598,21 @@ protected boolean isAuthorized(HttpServletRequest request, Method method) {
     }
 
     /**
-     * Decodes the body of a service request.
+     * Decodes the content of a service request.
      *
      * @param request
      * The servlet request.
      *
      * @param type
-     * The body type.
+     * The content type.
      *
      * @return
-     * The decoded body content.
+     * The decoded content.
      *
      * @throws IOException
-     * If an exception occurs while decoding the body.
+     * If an exception occurs while decoding the content.
      */
-    protected Object decodeBody(HttpServletRequest request, Class<?> type) throws IOException {
+    protected Object decodeContent(HttpServletRequest request, Class<?> type) throws IOException {
         JSONDecoder jsonDecoder = new JSONDecoder();
 
         return BeanAdapter.adapt(jsonDecoder.read(request.getInputStream()), type);
@@ -801,12 +801,12 @@ private void describeResource(String path, Resource resource, XMLStreamWriter xm
 
                     xmlStreamWriter.writeCharacters(entry.getKey().toUpperCase());
 
-                    Body body = handler.method.getAnnotation(Body.class);
+                    Content content = handler.method.getAnnotation(Content.class);
 
-                    if (body != null) {
+                    if (content != null) {
                         xmlStreamWriter.writeCharacters(" (");
 
-                        describeType(body.value(), xmlStreamWriter);
+                        describeType(content.value(), xmlStreamWriter);
 
                         xmlStreamWriter.writeCharacters(")");
                     }
diff --git a/httprpc-test/src/main/java/org/httprpc/test/TestService.java b/httprpc-test/src/main/java/org/httprpc/test/TestService.java
@@ -14,7 +14,7 @@
 
 package org.httprpc.test;
 
-import org.httprpc.Body;
+import org.httprpc.Content;
 import org.httprpc.Description;
 import org.httprpc.RequestMethod;
 import org.httprpc.ResourcePath;
@@ -104,7 +104,7 @@ public static class TestList extends ArrayList<Integer> {
     public static class TestMap extends HashMap<String, Double> {
     }
 
-    public interface Content {
+    public interface Body {
         String getString();
         List<String> getStrings();
         int getNumber();
@@ -259,9 +259,9 @@ public Response testPost(String string, List<String> strings, int number, boolea
     }
 
     @RequestMethod("POST")
-    @Body(Content.class)
-    public Content testPost(int id) {
-        return getBody();
+    @Content(Body.class)
+    public Body testPost(int id) {
+        return getContent();
     }
 
     @RequestMethod("POST")
diff --git a/httprpc-test/src/test/java/org/httprpc/WebServiceProxyTest.java b/httprpc-test/src/test/java/org/httprpc/WebServiceProxyTest.java
@@ -263,7 +263,7 @@ public void testBodyPost() throws IOException {
             (resourcePath) -> null, (method, url) -> {
             WebServiceProxy webServiceProxy = new WebServiceProxy(method, url);
 
-            webServiceProxy.setBody(content);
+            webServiceProxy.setContent(content);
 
             return webServiceProxy;
         });
