- Added javadoc for public and protected methods;

- Refactored pom.xml files for 2 spaces tabs; - Added gitignore rules for Netbeans IDE and test's output files. #5
OpenFeign · Sep 18, 2016 · 3b99835 · 3b99835
1 parent 00ec29b
commit 3b99835
Show file tree

Hide file tree

Showing 8 changed files with 307 additions and 223 deletions.
diff --git a/.gitignore b/.gitignore
@@ -97,3 +97,16 @@ buildNumber.properties
 *.ipr
 *.iws
 out/
+
+# Netbeans
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+nbactions.xml
+nb-configuration.xml
+.nb-gradle/
+
+# Test output log file
+*.txt
diff --git a/feign-form-spring/pom.xml b/feign-form-spring/pom.xml
@@ -3,36 +3,37 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
-    <modelVersion>4.0.0</modelVersion>   
-    <packaging>jar</packaging>
+  <modelVersion>4.0.0</modelVersion>   
+  <packaging>jar</packaging>
 
-    <artifactId>feign-form-spring</artifactId>
+  <artifactId>feign-form-spring</artifactId>
 
-    <parent>
-        <groupId>io.github.openfeign.form</groupId>
-        <artifactId>feign-form-parent</artifactId>
-        <version>2.0.1</version>
-    </parent>
+  <parent>
+    <groupId>io.github.openfeign.form</groupId>
+    <artifactId>feign-form-parent</artifactId>
+    <version>2.0.1</version>
+  </parent>
 
-    <name>Open Feign Forms Extension for Spring</name>   
+  <name>Open Feign Forms Extension for Spring</name>   
 
-    <dependencies>
-        <dependency>
-            <groupId>${project.groupId}</groupId>
-            <artifactId>feign-form</artifactId>
-            <version>${project.version}</version>
-            <scope>compile</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-web</artifactId>
-             <scope>compile</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework.cloud</groupId>
-            <artifactId>spring-cloud-starter-feign</artifactId>
-            <scope>test</scope>
-            <version>1.1.5.RELEASE</version>
-        </dependency>
-     </dependencies>
+  <dependencies>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>feign-form</artifactId>
+      <version>${project.version}</version>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-web</artifactId>
+      <scope>compile</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.springframework.cloud</groupId>
+      <artifactId>spring-cloud-starter-feign</artifactId>
+      <scope>test</scope>
+      <version>1.1.5.RELEASE</version>
+    </dependency>
+  </dependencies>
 </project>
diff --git a/feign-form/pom.xml b/feign-form/pom.xml
@@ -3,16 +3,16 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
-    <modelVersion>4.0.0</modelVersion>   
-    <packaging>jar</packaging>
+  <modelVersion>4.0.0</modelVersion>   
+  <packaging>jar</packaging>
 
-    <artifactId>feign-form</artifactId>
+  <artifactId>feign-form</artifactId>
 
-    <parent>
-        <groupId>io.github.openfeign.form</groupId>
-        <artifactId>feign-form-parent</artifactId>
-        <version>2.0.1</version>
-    </parent>
+  <parent>
+    <groupId>io.github.openfeign.form</groupId>
+    <artifactId>feign-form-parent</artifactId>
+    <version>2.0.1</version>
+  </parent>
 
-    <name>Open Feign Forms Core</name>   
+  <name>Open Feign Forms Core</name>   
 </project>
diff --git a/feign-form/src/main/java/feign/form/FormDataProcessor.java b/feign-form/src/main/java/feign/form/FormDataProcessor.java
@@ -19,12 +19,25 @@
 import java.util.Map;
 
 /**
+ * Interface for form data processing.
+ *
  * @author Artem Labazin <xxlabaza@gmail.com>
  * @since 30.04.2016
  */
 public interface FormDataProcessor {
 
+    /**
+     * Processing form data to request body.
+     *
+     * @param data form data, where key is a parameter name and value is...a value.
+     * @param template current request object.
+     */
     void process (Map<String, Object> data, RequestTemplate template);
 
+    /**
+     * Returns {@code FormDataProcessor} implementation supporting Content-Type.
+     *
+     * @return supported MIME Content-Type
+     */
     String getSupportetContentType ();
 }
diff --git a/feign-form/src/main/java/feign/form/FormEncodedDataProcessor.java b/feign-form/src/main/java/feign/form/FormEncodedDataProcessor.java
@@ -24,6 +24,8 @@
 import lombok.val;
 
 /**
+ * Form urlencoded implementation of {@link feign.form.FormDataProcessor}.
+ *
  * @author Artem Labazin <xxlabaza@gmail.com>
  * @since 30.04.2016
  */

diff --git a/feign-form/src/main/java/feign/form/FormEncoder.java b/feign-form/src/main/java/feign/form/FormEncoder.java
@@ -15,16 +15,48 @@
  */
 package feign.form;
 
+import feign.RequestTemplate;
+import feign.codec.Encoder;
 import java.lang.reflect.Type;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
-
-import feign.RequestTemplate;
-import feign.codec.Encoder;
 import lombok.val;
 
 /**
+ * Properly encodes requests with <b>application/x-www-form-urlencoded</b> and <b>multipart/form-data</b> Content-Type.
+ * <p>
+ * Also, the encoder has a <b>delegate</b> field for encoding non-form requests (like JSON or other).
+ * <p>
+ * Default <b>delegate</b> object is {@link feign.codec.Encoder.Default} instance.
+ * <p>
+ * Usage example:
+ * <p>
+ * <b>Declaring API interface:</b>
+ * <pre>
+ * interface SomeApi {
+ *
+ *     &#064;RequestLine("POST /json")
+ *     &#064;Headers("Content-Type: application/json")
+ *     void json (Dto dto);
+ *
+ *     &#064;RequestLine("POST /form")
+ *     &#064;Headers("Content-Type: application/x-www-form-urlencoded")
+ *     void from (@Param("field1") String field1, @Param("field2") String field2);
+ *
+ * }
+ * </pre>
+ * <p>
+ * <b>Creating Feign client instance:</b>
+ * <pre>
+ * SomeApi api = Feign.builder()
+ *       .encoder(new FormEncoder(new JacksonEncoder()))
+ *       .target(SomeApi.class, "http://localhost:8080");
+ * </pre>
+ * <p>
+ * Now it can handle JSON Content-Type by {@code feign.jackson.JacksonEncoder} and
+ * form request by {@link feign.form.FormEncoder}.
+ *
  * @author Artem Labazin <xxlabaza@gmail.com>
  * @since 30.04.2016
  */
@@ -34,10 +66,20 @@ public class FormEncoder implements Encoder {
 
     private final Map<String, FormDataProcessor> processors;
 
+    /**
+     * Default {@code FormEncoder} constructor.
+     * <p>
+     * Sets {@link feign.codec.Encoder.Default} instance as delegate encoder.
+     */
     public FormEncoder () {
         this(new Encoder.Default());
     }
 
+    /**
+     * {@code FormEncoder} constructor with delegate encoder argument.
+     * <p>
+     * @param delegate delegate encoder for processing non-form requests.
+     */
     public FormEncoder (Encoder delegate) {
         this.deligate = delegate;
         processors = new HashMap<String, FormDataProcessor>(2, 1.F);

diff --git a/feign-form/src/main/java/feign/form/MultipartEncodedDataProcessor.java b/feign-form/src/main/java/feign/form/MultipartEncodedDataProcessor.java
@@ -17,6 +17,7 @@
 
 import static feign.Util.UTF_8;
 
+import feign.RequestTemplate;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.FileInputStream;
@@ -26,12 +27,12 @@
 import java.io.PrintWriter;
 import java.net.URLConnection;
 import java.util.Map;
-
-import feign.RequestTemplate;
 import lombok.SneakyThrows;
 import lombok.val;
 
 /**
+ * Multipart form data implementation of {@link feign.form.FormDataProcessor}.
+ *
  * @author Artem Labazin <xxlabaza@gmail.com>
  * @since 30.04.2016
  */
@@ -89,20 +90,23 @@ public String getSupportetContentType () {
         return CONTENT_TYPE;
     }
 
-    private String createBoundary () {
-        return Long.toHexString(System.currentTimeMillis());
-    }
-
+    /**
+     * Checks is passed object a supported file's type or not.
+     *
+     * @param value form file parameter.
+     */
     protected boolean isFile (Object value) {
         return value != null && (value instanceof File || value instanceof byte[]);
     }
 
-    private void writeParameter (PrintWriter writer, String name, String value) {
-        writer.append("Content-Disposition: form-data; name=\"" + name + "\"").append(CRLF);
-        writer.append("Content-Type: text/plain; charset=UTF-8").append(CRLF);
-        writer.append(CRLF).append(value);
-    }
-
+    /**
+     * Writes file's content to output stream.
+     *
+     * @param output output stream to remote destination.
+     * @param writer wrapped output stream.
+     * @param name file's name.
+     * @param value file's content.
+     */
     protected void writeFile (OutputStream output, PrintWriter writer, String name, Object value) {
         if (value instanceof byte[]) {
             writeFile(output, writer, name, (byte[]) value);
@@ -111,6 +115,16 @@ protected void writeFile (OutputStream output, PrintWriter writer, String name,
         writeFile(output, writer, name, (File) value);
     }
 
+    private String createBoundary () {
+        return Long.toHexString(System.currentTimeMillis());
+    }
+
+    private void writeParameter (PrintWriter writer, String name, String value) {
+        writer.append("Content-Disposition: form-data; name=\"" + name + "\"").append(CRLF);
+        writer.append("Content-Type: text/plain; charset=UTF-8").append(CRLF);
+        writer.append(CRLF).append(value);
+    }
+
     @SneakyThrows
     private void writeFile (OutputStream output, PrintWriter writer, String name, File file) {
         writeFileMeta(writer, name, file.getName());