Make Parts immutable

Author: Stephane Landelle

api/src/main/java/org/asynchttpclient/multipart/Part.java

@@ -34,82 +34,82 @@ public abstract class Part {
     /**
      * Carriage return/linefeed
      */
-    protected static final String CRLF = "\r\n";
+    public static final String CRLF = "\r\n";
 
     /**
      * Carriage return/linefeed as a byte array
      */
-    static final byte[] CRLF_BYTES = MultipartEncodingUtil.getAsciiBytes(CRLF);
+    public static final byte[] CRLF_BYTES = MultipartEncodingUtil.getAsciiBytes(CRLF);
 
     /**
      * Content dispostion characters
      */
-    protected static final String QUOTE = "\"";
+    public static final String QUOTE = "\"";
 
     /**
      * Content dispostion as a byte array
      */
-    static final byte[] QUOTE_BYTES = MultipartEncodingUtil.getAsciiBytes(QUOTE);
+    public static final byte[] QUOTE_BYTES = MultipartEncodingUtil.getAsciiBytes(QUOTE);
 
     /**
      * Extra characters
      */
-    protected static final String EXTRA = "--";
+    public static final String EXTRA = "--";
 
     /**
      * Extra characters as a byte array
      */
-    static final byte[] EXTRA_BYTES = MultipartEncodingUtil.getAsciiBytes(EXTRA);
+    public static final byte[] EXTRA_BYTES = MultipartEncodingUtil.getAsciiBytes(EXTRA);
 
     /**
      * Content dispostion characters
      */
-    protected static final String CONTENT_DISPOSITION = "Content-Disposition: form-data; name=";
+    public static final String CONTENT_DISPOSITION = "Content-Disposition: form-data; name=";
 
     /**
      * Content dispostion as a byte array
      */
-    static final byte[] CONTENT_DISPOSITION_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_DISPOSITION);
+    public static final byte[] CONTENT_DISPOSITION_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_DISPOSITION);
 
     /**
      * Content type header
      */
-    protected static final String CONTENT_TYPE = "Content-Type: ";
+    public static final String CONTENT_TYPE = "Content-Type: ";
 
     /**
      * Content type header as a byte array
      */
-    static final byte[] CONTENT_TYPE_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_TYPE);
+    public static final byte[] CONTENT_TYPE_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_TYPE);
 
     /**
      * Content charset
      */
-    protected static final String CHARSET = "; charset=";
+    public static final String CHARSET = "; charset=";
 
     /**
      * Content charset as a byte array
      */
-    static final byte[] CHARSET_BYTES = MultipartEncodingUtil.getAsciiBytes(CHARSET);
+    public static final byte[] CHARSET_BYTES = MultipartEncodingUtil.getAsciiBytes(CHARSET);
 
     /**
      * Content type header
      */
-    protected static final String CONTENT_TRANSFER_ENCODING = "Content-Transfer-Encoding: ";
+    public static final String CONTENT_TRANSFER_ENCODING = "Content-Transfer-Encoding: ";
 
     /**
      * Content type header as a byte array
      */
-    static final byte[] CONTENT_TRANSFER_ENCODING_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_TRANSFER_ENCODING);
+    public static final byte[] CONTENT_TRANSFER_ENCODING_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_TRANSFER_ENCODING);
 
     /**
      * Content type header
      */
-    protected static final String CONTENT_ID = "Content-ID: ";
+    public static final String CONTENT_ID = "Content-ID: ";
 
     /**
      * Content type header as a byte array
      */
-    static final byte[] CONTENT_ID_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_ID);
+    public static final byte[] CONTENT_ID_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_ID);
 
     /**
      * Return the name of this part.

api/src/main/java/org/asynchttpclient/multipart/PartBase.java

@@ -25,24 +25,24 @@ public abstract class PartBase extends Part {
     /**
      * Name of the file part.
      */
-    private String name;
+    private final String name;
 
     /**
      * Content type of the file part.
      */
-    private String contentType;
+    private final String contentType;
 
     /**
      * Content encoding of the file part.
      */
-    private String charSet;
+    private final String charSet;
 
     /**
      * The transfer encoding.
      */
-    private String transferEncoding;
+    private final String transferEncoding;
 
-    private String contentId;
+    private final String contentId;
 
     /**
      * Constructor.
@@ -101,50 +101,7 @@ public String getTransferEncoding() {
         return transferEncoding;
     }
 
-    /**
-     * Sets the character encoding.
-     * 
-     * @param charSet the character encoding, or <code>null</code> to exclude the character encoding header
-     */
-    public void setCharSet(String charSet) {
-        this.charSet = charSet;
-    }
-
-    /**
-     * Sets the content type.
-     * 
-     * @param contentType the content type, or <code>null</code> to exclude the content type header
-     */
-    public void setContentType(String contentType) {
-        this.contentType = contentType;
-    }
-
-    /**
-     * Sets the part name.
-     * 
-     * @param name
-     */
-    public void setName(String name) {
-        if (name == null) {
-            throw new IllegalArgumentException("Name must not be null");
-        }
-        this.name = name;
-    }
-
-    /**
-     * Sets the transfer encoding.
-     * 
-     * @param transferEncoding the transfer encoding, or <code>null</code> to exclude the transfer encoding header
-     */
-    public void setTransferEncoding(String transferEncoding) {
-        this.transferEncoding = transferEncoding;
-    }
-
     public String getContentId() {
         return contentId;
     }
-
-    public void setContentId(String contentId) {
-        this.contentId = contentId;
-    }
 }

api/src/main/java/org/asynchttpclient/multipart/StringPart.java

@@ -43,13 +43,12 @@ public class StringPart extends PartBase {
     /**
      * Contents of this StringPart.
      */
-    private byte[] content;
-
-    /**
-     * The String value of this part.
-     */
-    private final String value;
+    private final byte[] content;
 
+    public StringPart(String name, String value, String charset) {
+        this(name, value, charset, null);
+    }
+    
     /**
      * Constructor.
      * 
@@ -68,21 +67,7 @@ public StringPart(String name, String value, String charset, String contentId) {
             // See RFC 2048, 2.8. "8bit Data"
             throw new IllegalArgumentException("NULs may not be present in string parts");
         }
-        this.value = value;
-    }
-
-    public StringPart(String name, String value, String charset) {
-        this(name, value, charset, null);
-    }
-
-    /**
-     * Constructor.
-     * 
-     * @param name The name of the part
-     * @param value the string to post
-     */
-    public StringPart(String name, String value) {
-        this(name, value, null, null);
+        content = MultipartEncodingUtil.getBytes(value, charset);
     }
 
     /**
@@ -91,9 +76,6 @@ public StringPart(String name, String value) {
      * @return the content in bytes
      */
     private byte[] getContent() {
-        if (content == null) {
-            content = MultipartEncodingUtil.getBytes(value, getCharSet());
-        }
         return content;
     }
 
@@ -115,15 +97,4 @@ protected void sendData(OutputStream out) throws IOException {
     protected long lengthOfData() {
         return getContent().length;
     }
-
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.apache.commons.httpclient.methods.multipart.BasePart#setCharSet(java.lang.String)
-     */
-    public void setCharSet(String charSet) {
-        super.setCharSet(charSet);
-        this.content = null;
-    }
-
 }

api/src/test/java/org/asynchttpclient/async/AsyncProvidersBasicTest.java

@@ -653,7 +653,7 @@ public void asyncDoPostMultiPartTest() throws Exception {
         try {
             final CountDownLatch l = new CountDownLatch(1);
 
-            Part p = new StringPart("foo", "bar");
+            Part p = new StringPart("foo", "bar", "UTF-8");
 
             client.preparePost(getTargetUrl()).addBodyPart(p).execute(new AsyncCompletionHandlerAdapter() {
 

api/src/test/java/org/asynchttpclient/async/MultipartUploadTest.java

@@ -170,7 +170,7 @@ public void testSendingSmallFilesAndByteArray() {
             builder.setUrl("http://localhost" + ":" + port1 + "/upload/bob");
             builder.addBodyPart(new FilePart("file1", testResource1File, "text/plain", "UTF-8"));
             builder.addBodyPart(new FilePart("file2", testResource2File, "application/x-gzip", null));
-            builder.addBodyPart(new StringPart("Name", "Dominic"));
+            builder.addBodyPart(new StringPart("Name", "Dominic", "UTF-8"));
             builder.addBodyPart(new FilePart("file3", testResource3File, "text/plain", "UTF-8"));
 
             builder.addBodyPart(new StringPart("Age", "3", AsyncHttpProviderUtils.DEFAULT_CHARSET));