Have Parts take a java.nio.Charset instead of a String, close AsyncHttpClient#652

Author: Stephane Landelle

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

@@ -16,6 +16,7 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+import java.nio.charset.Charset;
 
 /**
  * This class is an adaptation of the Apache HttpClient implementation
@@ -55,7 +56,7 @@ public abstract class AbstractFilePart extends PartBase {
  * @param charset
  * the charset encoding for this part
  */
- public AbstractFilePart(String name, String contentType, String charset, String contentId, String transfertEncoding) {
+ public AbstractFilePart(String name, String contentType, Charset charset, String contentId, String transfertEncoding) {
  super(name,//
  contentType == null ? DEFAULT_CONTENT_TYPE : contentType,//
  charset,//

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

@@ -15,6 +15,7 @@
 import java.io.IOException;
 import java.io.OutputStream;
 import java.nio.channels.WritableByteChannel;
+import java.nio.charset.Charset;
 
 public class ByteArrayPart extends AbstractFilePart {
 
@@ -28,19 +29,19 @@ public ByteArrayPart(String name, byte[] bytes, String contentType) {
  this(name, bytes, contentType, null);
  }
 
- public ByteArrayPart(String name, byte[] bytes, String contentType, String charset) {
+ public ByteArrayPart(String name, byte[] bytes, String contentType, Charset charset) {
  this(name, bytes, contentType, charset, null);
  }
 
- public ByteArrayPart(String name, byte[] bytes, String contentType, String charset, String fileName) {
+ public ByteArrayPart(String name, byte[] bytes, String contentType, Charset charset, String fileName) {
  this(name, bytes, contentType, charset, fileName, null);
  }
 
- public ByteArrayPart(String name, byte[] bytes, String contentType, String charset, String fileName, String contentId) {
+ public ByteArrayPart(String name, byte[] bytes, String contentType, Charset charset, String fileName, String contentId) {
  this(name, bytes, contentType, charset, fileName, contentId, null);
  }
 
- public ByteArrayPart(String name, byte[] bytes, String contentType, String charset, String fileName, String contentId, String transferEncoding) {
+ public ByteArrayPart(String name, byte[] bytes, String contentType, Charset charset, String fileName, String contentId, String transferEncoding) {
  super(name, contentType, charset, contentId, transferEncoding);
  if (bytes == null)
  throw new NullPointerException("bytes");

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

@@ -12,9 +12,6 @@
  */
 package org.asynchttpclient.multipart;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
@@ -23,6 +20,10 @@
 import java.io.RandomAccessFile;
 import java.nio.channels.FileChannel;
 import java.nio.channels.WritableByteChannel;
+import java.nio.charset.Charset;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class FilePart extends AbstractFilePart {
 
@@ -38,19 +39,19 @@ public FilePart(String name, File file, String contentType) {
  this(name, file, contentType, null);
  }
 
- public FilePart(String name, File file, String contentType, String charset) {
+ public FilePart(String name, File file, String contentType, Charset charset) {
  this(name, file, contentType, charset, null);
  }
 
- public FilePart(String name, File file, String contentType, String charset, String fileName) {
+ public FilePart(String name, File file, String contentType, Charset charset, String fileName) {
  this(name, file, contentType, charset, fileName, null);
  }
 
- public FilePart(String name, File file, String contentType, String charset, String fileName, String contentId) {
+ public FilePart(String name, File file, String contentType, Charset charset, String fileName, String contentId) {
  this(name, file, contentType, charset, fileName, contentId, null);
  }
 
- public FilePart(String name, File file, String contentType, String charset, String fileName, String contentId, String transferEncoding) {
+ public FilePart(String name, File file, String contentType, Charset charset, String fileName, String contentId, String transferEncoding) {
  super(name, contentType, charset, contentId, transferEncoding);
  if (file == null)
  throw new NullPointerException("file");

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

@@ -17,6 +17,7 @@
 import java.io.IOException;
 import java.io.OutputStream;
 import java.nio.channels.WritableByteChannel;
+import java.nio.charset.Charset;
 
 public interface Part {
 
@@ -89,7 +90,7 @@ public interface Part {
  * 
  * @return the character encoding, or <code>null</code> to exclude the character encoding header
  */
- String getCharSet();
+ Charset getCharset();
 
  /**
  * Return the transfer encoding of this part.

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

@@ -16,6 +16,7 @@
 
 import java.io.IOException;
 import java.io.OutputStream;
+import java.nio.charset.Charset;
 
 public abstract class PartBase implements Part {
 
@@ -32,7 +33,7 @@ public abstract class PartBase implements Part {
  /**
  * The charset (part of Content-Type header)
  */
- private final String charSet;
+ private final Charset charset;
 
  /**
  * The Content-Transfer-Encoding header value.
@@ -54,14 +55,14 @@ public abstract class PartBase implements Part {
  * 
  * @param name The name of the part, or <code>null</code>
  * @param contentType The content type, or <code>null</code>
- * @param charSet The character encoding, or <code>null</code>
+ * @param charset The character encoding, or <code>null</code>
  * @param contentId The content id, or <code>null</code>
  * @param transferEncoding The transfer encoding, or <code>null</code>
  */
- public PartBase(String name, String contentType, String charSet, String contentId, String transferEncoding) {
+ public PartBase(String name, String contentType, Charset charset, String contentId, String transferEncoding) {
  this.name = name;
  this.contentType = contentType;
- this.charSet = charSet;
+ this.charset = charset;
  this.contentId = contentId;
  this.transferEncoding = transferEncoding;
  }
@@ -89,10 +90,10 @@ protected void visitContentTypeHeader(PartVisitor visitor) throws IOException {
  visitor.withBytes(CRLF_BYTES);
  visitor.withBytes(CONTENT_TYPE_BYTES);
  visitor.withBytes(contentType.getBytes(US_ASCII));
- String charSet = getCharSet();
+ Charset charSet = getCharset();
  if (charSet != null) {
  visitor.withBytes(CHARSET_BYTES);
- visitor.withBytes(charSet.getBytes(US_ASCII));
+ visitor.withBytes(charset.name().getBytes(US_ASCII));
  }
  }
  }
@@ -186,7 +187,7 @@ public String toString() {
  .append(getClass().getSimpleName())//
  .append(" name=").append(getName())//
  .append(" contentType=").append(getContentType())//
- .append(" charset=").append(getCharSet())//
+ .append(" charset=").append(getCharset())//
  .append(" tranferEncoding=").append(getTransferEncoding())//
  .append(" contentId=").append(getContentId())//
  .append(" dispositionType=").append(getDispositionType())//
@@ -204,8 +205,8 @@ public String getContentType() {
  }
 
  @Override
- public String getCharSet() {
- return this.charSet;
+ public Charset getCharset() {
+ return this.charset;
  }
 
  @Override

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

@@ -42,11 +42,11 @@ public class StringPart extends PartBase {
  */
  private final byte[] content;
 
- private static Charset charsetOrDefault(String charset) {
- return charset == null ? DEFAULT_CHARSET : Charset.forName(charset);
+ private static Charset charsetOrDefault(Charset charset) {
+ return charset == null ? DEFAULT_CHARSET : charset;
  }
 
- public StringPart(String name, String value, String charset) {
+ public StringPart(String name, String value, Charset charset) {
  this(name, value, charset, null);
  }
 
@@ -62,9 +62,9 @@ public StringPart(String name, String value, String charset) {
  * @param contentId
  * the content id
  */
- public StringPart(String name, String value, String charset, String contentId) {
+ public StringPart(String name, String value, Charset charset, String contentId) {
 
- super(name, DEFAULT_CONTENT_TYPE, charsetOrDefault(charset).name(), DEFAULT_TRANSFER_ENCODING, contentId);
+ super(name, DEFAULT_CONTENT_TYPE, charsetOrDefault(charset), DEFAULT_TRANSFER_ENCODING, contentId);
  if (value == null)
  throw new NullPointerException("value");
  if (value.indexOf(0) != -1)

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

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

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

@@ -53,7 +53,7 @@ public void testUnauthorizedWhileUploading() throws Exception {
 
  AsyncHttpClient client = getAsyncHttpClient(null);
  try {
- Response response = client.preparePut(getTargetUrl()).addBodyPart(new FilePart("test", file, "application/octet-stream", StandardCharsets.UTF_8.name())).execute()
+ Response response = client.preparePut(getTargetUrl()).addBodyPart(new FilePart("test", file, "application/octet-stream", StandardCharsets.UTF_8)).execute()
  .get();
  assertEquals(response.getStatusCode(), 401);
  } finally {

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

@@ -64,7 +64,7 @@ public void handle(String target, Request baseRequest, HttpServletRequest req, H
  public void testPutImageFile() throws Exception {
  AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeout(100 * 6000).build());
  try {
- Response response = client.preparePut(getTargetUrl()).addBodyPart(new FilePart("test", LARGE_IMAGE_FILE, "application/octet-stream", StandardCharsets.UTF_8.name())).execute().get();
+ Response response = client.preparePut(getTargetUrl()).addBodyPart(new FilePart("test", LARGE_IMAGE_FILE, "application/octet-stream", StandardCharsets.UTF_8)).execute().get();
  assertEquals(response.getStatusCode(), 200);
  } finally {
  client.close();
@@ -77,7 +77,7 @@ public void testPutLargeTextFile() throws Exception {
 
  AsyncHttpClient client = getAsyncHttpClient(null);
  try {
- Response response = client.preparePut(getTargetUrl()).addBodyPart(new FilePart("test", file, "application/octet-stream", StandardCharsets.UTF_8.name())).execute().get();
+ Response response = client.preparePut(getTargetUrl()).addBodyPart(new FilePart("test", file, "application/octet-stream", StandardCharsets.UTF_8)).execute().get();
  assertEquals(response.getStatusCode(), 200);
  } finally {
  client.close();

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

@@ -174,16 +174,16 @@ public void testSendingSmallFilesAndByteArray() {
 
  RequestBuilder builder = new RequestBuilder("POST");
  builder.setUrl("http://localhost" + ":" + port1 + "/upload/bob");
- builder.addBodyPart(new FilePart("file1", testResource1File, "text/plain", StandardCharsets.UTF_8.name()));
+ builder.addBodyPart(new FilePart("file1", testResource1File, "text/plain", StandardCharsets.UTF_8));
  builder.addBodyPart(new FilePart("file2", testResource2File, "application/x-gzip", null));
- builder.addBodyPart(new StringPart("Name", "Dominic", StandardCharsets.UTF_8.name()));
- builder.addBodyPart(new FilePart("file3", testResource3File, "text/plain", StandardCharsets.UTF_8.name()));
+ builder.addBodyPart(new StringPart("Name", "Dominic", StandardCharsets.UTF_8));
+ builder.addBodyPart(new FilePart("file3", testResource3File, "text/plain", StandardCharsets.UTF_8));
 
- builder.addBodyPart(new StringPart("Age", "3", AsyncHttpProviderUtils.DEFAULT_CHARSET.name()));
- builder.addBodyPart(new StringPart("Height", "shrimplike", AsyncHttpProviderUtils.DEFAULT_CHARSET.name()));
- builder.addBodyPart(new StringPart("Hair", "ridiculous", AsyncHttpProviderUtils.DEFAULT_CHARSET.name()));
+ builder.addBodyPart(new StringPart("Age", "3", AsyncHttpProviderUtils.DEFAULT_CHARSET));
+ builder.addBodyPart(new StringPart("Height", "shrimplike", AsyncHttpProviderUtils.DEFAULT_CHARSET));
+ builder.addBodyPart(new StringPart("Hair", "ridiculous", AsyncHttpProviderUtils.DEFAULT_CHARSET));
 
- builder.addBodyPart(new ByteArrayPart("file4", expectedContents.getBytes(StandardCharsets.UTF_8), "text/plain", StandardCharsets.UTF_8.name(), "bytearray.txt"));
+ builder.addBodyPart(new ByteArrayPart("file4", expectedContents.getBytes(StandardCharsets.UTF_8), "text/plain", StandardCharsets.UTF_8, "bytearray.txt"));
 
  Request r = builder.build();