Rework Part API, first take

Author: Stephane Landelle

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

@@ -0,0 +1,113 @@
+/*
+ * Copyright 2010 Ning, Inc.
+ *
+ * Ning licenses this file to you 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 org.asynchttpclient.multipart;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * This class is an adaptation of the Apache HttpClient implementation
+ * 
+ * @link http://hc.apache.org/httpclient-3.x/
+ */
+public abstract class AbstractFilePart extends PartBase {
+
+    /**
+     * Default content encoding of file attachments.
+     */
+    public static final String DEFAULT_CONTENT_TYPE = "application/octet-stream";
+
+    /**
+     * Default charset of file attachments.
+     */
+    public static final String DEFAULT_CHARSET = "ISO-8859-1";
+
+    /**
+     * Default transfer encoding of file attachments.
+     */
+    public static final String DEFAULT_TRANSFER_ENCODING = "binary";
+
+    /**
+     * Attachment's file name
+     */
+    protected static final String FILE_NAME = "; filename=";
+
+    /**
+     * Attachment's file name as a byte array
+     */
+    private static final byte[] FILE_NAME_BYTES = MultipartEncodingUtil.getAsciiBytes(FILE_NAME);
+
+    // FIXME used?
+    private long _stalledTime = -1;
+
+    /**
+     * FilePart Constructor.
+     * 
+     * @param name
+     *            the name for this part
+     * @param partSource
+     *            the source for this part
+     * @param contentType
+     *            the content type for this part, if <code>null</code> the {@link #DEFAULT_CONTENT_TYPE default} is used
+     * @param charset
+     *            the charset encoding for this part, if <code>null</code> the {@link #DEFAULT_CHARSET default} is used
+     * @param contentId
+     */
+    public AbstractFilePart(String name, String contentType, String charset, String contentId) {
+        super(name, contentType == null ? DEFAULT_CONTENT_TYPE : contentType, charset == null ? "ISO-8859-1" : charset, DEFAULT_TRANSFER_ENCODING, contentId);
+    }
+
+    public abstract String getFileName();
+
+    /**
+     * Write the disposition header to the output stream
+     * 
+     * @param out
+     *            The output stream
+     * @throws java.io.IOException
+     *             If an IO problem occurs
+     */
+    protected void sendDispositionHeader(OutputStream out) throws IOException {
+        super.sendDispositionHeader(out);
+        String filename = getFileName();
+        if (filename != null) {
+            out.write(FILE_NAME_BYTES);
+            out.write(QUOTE_BYTES);
+            out.write(MultipartEncodingUtil.getAsciiBytes(filename));
+            out.write(QUOTE_BYTES);
+        }
+    }
+
+    protected long dispositionHeaderLength() {
+        String filename = this.getFileName();
+        long length = super.dispositionHeaderLength();
+        if (filename != null) {
+            length += FILE_NAME_BYTES.length;
+            length += QUOTE_BYTES.length;
+            length += MultipartEncodingUtil.getAsciiBytes(filename).length;
+            length += QUOTE_BYTES.length;
+        }
+        return length;
+    }
+
+    public void setStalledTime(long ms) {
+        _stalledTime = ms;
+    }
+
+    public long getStalledTime() {
+        return _stalledTime;
+    }
+}

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

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2010 Ning, Inc.
+ *
+ * Ning licenses this file to you 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 org.asynchttpclient.multipart;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+public class ByteArrayPart extends AbstractFilePart {
+
+    private final byte[] bytes;
+    private final String fileName;
+
+    public ByteArrayPart(String name, byte[] bytes) {
+        this(name, bytes, null);
+    }
+
+    public ByteArrayPart(String name, byte[] bytes, String contentType) {
+        this(name, bytes, contentType, null);
+    }
+
+    public ByteArrayPart(String name, byte[] bytes, String contentType, String charset) {
+        this(name, bytes, contentType, charset, null);
+    }
+
+    public ByteArrayPart(String name, byte[] bytes, String contentType, String charset, String fileName) {
+        this(name, bytes, contentType, charset, fileName, null);
+    }
+
+    public ByteArrayPart(String name, byte[] bytes, String contentType, String charset, String fileName, String contentId) {
+        super(name, contentType, charset, contentId);
+        if (bytes == null) {
+            throw new NullPointerException("bytes");
+        }
+        this.bytes = bytes;
+        this.fileName = fileName;
+    }
+
+    @Override
+    public String getFileName() {
+        return fileName;
+    }
+
+    @Override
+    protected void sendData(OutputStream out) throws IOException {
+        out.write(bytes);
+    }
+
+    @Override
+    protected long lengthOfData() {
+        return bytes.length;
+    }
+
+    public byte[] getBytes() {
+        return bytes;
+    }
+}