First step in making parts immutable and thread safe

Author: Stephane Landelle

src/main/java/com/ning/http/client/ByteArrayPart.java

@@ -17,11 +17,11 @@
 package com.ning.http.client;
 
 public class ByteArrayPart implements Part {
-    private String name;
-    private String fileName;
-    private byte[] data;
-    private String mimeType;
-    private String charSet;
+    private final String name;
+    private final String fileName;
+    private final byte[] data;
+    private final String mimeType;
+    private final String charSet;
 
     public ByteArrayPart(String name, String fileName, byte[] data, String mimeType, String charSet) {
         this.name = name;

src/main/java/com/ning/http/client/FilePart.java

@@ -22,10 +22,10 @@
  * A file multipart part.
  */
 public class FilePart implements Part {
-    private String name;
-    private File file;
-    private String mimeType;
-    private String charSet;
+    private final String name;
+    private final File file;
+    private final String mimeType;
+    private final String charSet;
 
     public FilePart(String name, File file, String mimeType, String charSet) {
         this.name = name;
@@ -37,7 +37,6 @@ public FilePart(String name, File file, String mimeType, String charSet) {
     /**
      * {@inheritDoc}
      */
-    /* @Override */
     public String getName() {
         return name;
     }

src/main/java/com/ning/http/multipart/MultipartBody.java

@@ -251,8 +251,6 @@ private void initializeFileBody(FilePart currentPart)
     private void initializeFilePart(FilePart filePart)
             throws IOException {
 
-        filePart.setPartBoundary(boundary);
-
         ByteArrayOutputStream output = generateFileStart(filePart);
 
         initializeBuffer(output.toByteArray());
@@ -262,7 +260,6 @@ private void initializeFilePart(FilePart filePart)
 
     private void initializeStringPart(StringPart currentPart)
             throws IOException {
-        currentPart.setPartBoundary(boundary);
 
         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
 
@@ -404,7 +401,6 @@ private ByteArrayOutputStream generateFileEnd(FilePart filePart)
     }
 
     private long handleFileHeaders(WritableByteChannel target, FilePart filePart) throws IOException {
-        filePart.setPartBoundary(boundary);
 
         ByteArrayOutputStream overhead = generateFileStart(filePart);
 
@@ -415,9 +411,7 @@ private ByteArrayOutputStream generateFileStart(FilePart filePart)
             throws IOException {
         ByteArrayOutputStream overhead = new ByteArrayOutputStream();
 
-        filePart.setPartBoundary(boundary);
-
-        filePart.sendStart(overhead);
+        filePart.sendStart(overhead, boundary);
         filePart.sendDispositionHeader(overhead);
         filePart.sendContentTypeHeader(overhead);
         filePart.sendTransferEncodingHeader(overhead);
@@ -531,8 +525,6 @@ private long handlePartSource(WritableByteChannel target, FilePart filePart) thr
 
     private long handleStringPart(WritableByteChannel target, StringPart currentPart) throws IOException {
 
-        currentPart.setPartBoundary(boundary);
-
         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
 
         Part.sendPart(outputStream, currentPart, boundary);
@@ -542,8 +534,6 @@ private long handleStringPart(WritableByteChannel target, StringPart currentPart
 
     private long handleMultiPart(WritableByteChannel target, Part currentPart) throws IOException {
 
-        currentPart.setPartBoundary(boundary);
-
         if (currentPart.getClass().equals(StringPart.class)) {
             return handleStringPart(target, (StringPart) currentPart);
         } else if (currentPart.getClass().equals(FilePart.class)) {

src/main/java/com/ning/http/multipart/Part.java

@@ -25,16 +25,6 @@
  */
 public abstract class Part implements com.ning.http.client.Part {
 
-    /**
-     * The boundary
-     */
-    protected static final String BOUNDARY = "----------------314159265358979323846";
-
-    /**
-     * The default boundary to be used if etBoundaryBytes(byte[]) has not been called.
-     */
-    private static final byte[] DEFAULT_BOUNDARY_BYTES = MultipartEncodingUtil.getAsciiBytes(BOUNDARY);
-
     /**
      * Carriage return/linefeed
      */
@@ -115,21 +105,6 @@ public abstract class Part implements com.ning.http.client.Part {
      */
     static final byte[] CONTENT_ID_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_ID);
 
-    /**
-     * Return the boundary string.
-     * 
-     * @return the boundary string
-     * @deprecated uses a constant string. Rather use {@link #getPartBoundary}
-     */
-    public static String getBoundary() {
-        return BOUNDARY;
-    }
-
-    /**
-     * The ASCII bytes to use as the multipart boundary.
-     */
-    private byte[] boundaryBytes;
-
     /**
      * Return the name of this part.
      * 
@@ -165,31 +140,6 @@ public static String getBoundary() {
      */
     public abstract String getContentId();
 
-    /**
-     * Gets the part boundary to be used.
-     * 
-     * @return the part boundary as an array of bytes.
-     * @since 3.0
-     */
-    protected byte[] getPartBoundary() {
-        if (boundaryBytes == null) {
-            // custom boundary bytes have not been set, use the default.
-            return DEFAULT_BOUNDARY_BYTES;
-        } else {
-            return boundaryBytes;
-        }
-    }
-
-    /**
-     * Sets the part boundary. Only meant to be used by {@link Part#sendParts(java.io.OutputStream, Part[], byte[])} and {@link Part#getLengthOfParts(Part[], byte[])}
-     * 
-     * @param boundaryBytes An array of ASCII bytes.
-     * @since 3.0
-     */
-    void setPartBoundary(byte[] boundaryBytes) {
-        this.boundaryBytes = boundaryBytes;
-    }
-
     /**
      * Tests if this part can be sent more than once.
      * 
@@ -204,15 +154,16 @@ public boolean isRepeatable() {
      * Write the start to the specified output stream
      * 
      * @param out The output stream
+     * @param boundary the boundary
      * @throws java.io.IOException If an IO problem occurs.
      */
-    protected void sendStart(OutputStream out) throws IOException {
+    protected void sendStart(OutputStream out, byte[] boundary) throws IOException {
         out.write(EXTRA_BYTES);
-        out.write(getPartBoundary());
+        out.write(boundary);
     }
 
-    private int startLength() {
-        return EXTRA_BYTES.length + getPartBoundary().length;
+    private int startLength(byte[] boundary) {
+        return EXTRA_BYTES.length + boundary.length;
     }
 
     /**
@@ -379,10 +330,11 @@ protected long endLength() {
      * Write all the data to the output stream. If you override this method make sure to override #length() as well
      * 
      * @param out The output stream
+     * @param boundary the boundary
      * @throws IOException If an IO problem occurs.
      */
-    public void send(OutputStream out) throws IOException {
-        sendStart(out);
+    public void send(OutputStream out, byte[] boundary) throws IOException {
+        sendStart(out, boundary);
         sendDispositionHeader(out);
         sendContentTypeHeader(out);
         sendTransferEncodingHeader(out);
@@ -398,15 +350,15 @@ public void send(OutputStream out) throws IOException {
      * @return long The length.
      * @throws IOException If an IO problem occurs
      */
-    public long length() {
+    public long length(byte[] boundary) {
 
         long lengthOfData = lengthOfData();
 
         if (lengthOfData < 0L) {
             return -1L;
         } else {
             return lengthOfData//
-                    + startLength()//
+                    + startLength(boundary)//
                     + dispositionHeaderLength()//
                     + contentTypeHeaderLength()//
                     + transferEncodingHeaderLength()//
@@ -426,17 +378,6 @@ public String toString() {
         return this.getName();
     }
 
-    /**
-     * Write all parts and the last boundary to the specified output stream.
-     * 
-     * @param out The stream to write to.
-     * @param parts The parts to write.
-     * @throws IOException If an I/O error occurs while writing the parts.
-     */
-    public static void sendParts(OutputStream out, final Part[] parts) throws IOException {
-        sendParts(out, parts, DEFAULT_BOUNDARY_BYTES);
-    }
-
     /**
      * Write all parts and the last boundary to the specified output stream.
      * 
@@ -455,9 +396,7 @@ public static void sendParts(OutputStream out, Part[] parts, byte[] partBoundary
             throw new IllegalArgumentException("partBoundary may not be empty");
         }
         for (Part part : parts) {
-            // set the part boundary before the part is sent
-            part.setPartBoundary(partBoundary);
-            part.send(out);
+            part.send(out, partBoundary);
         }
         out.write(EXTRA_BYTES);
         out.write(partBoundary);
@@ -491,8 +430,7 @@ public static void sendPart(OutputStream out, Part part, byte[] partBoundary) th
             throw new IllegalArgumentException("Parts may not be null");
         }
 
-        part.setPartBoundary(partBoundary);
-        part.send(out);
+        part.send(out, partBoundary);
     }
 
     /**
@@ -510,9 +448,7 @@ public static long getLengthOfParts(Part[] parts, byte[] partBoundary) {
         }
         long total = 0;
         for (Part part : parts) {
-            // set the part boundary before we calculate the part's length
-            part.setPartBoundary(partBoundary);
-            long l = part.length();
+            long l = part.length(partBoundary);
             if (l < 0) {
                 return -1;
             }