You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by gg...@apache.org on 2020/01/15 01:50:24 UTC
[httpcomponents-core] branch master updated: Add PathEntity,
a Path based implementation of HttpEntity. (#188)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/httpcomponents-core.git
The following commit(s) were added to refs/heads/master by this push:
new 55bb5e7 Add PathEntity, a Path based implementation of HttpEntity. (#188)
55bb5e7 is described below
commit 55bb5e76b70f066ac7320f6211d13ffcb04cf093
Author: Gary Gregory <ga...@users.noreply.github.com>
AuthorDate: Tue Jan 14 20:50:17 2020 -0500
Add PathEntity, a Path based implementation of HttpEntity. (#188)
---
.../hc/core5/http/io/entity/HttpEntities.java | 13 +++
.../apache/hc/core5/http/io/entity/PathEntity.java | 87 +++++++++++++++++
.../hc/core5/http/io/entity/TestPathEntity.java | 107 +++++++++++++++++++++
3 files changed, 207 insertions(+)
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/HttpEntities.java b/httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/HttpEntities.java
index 5f5a29f..597e1ea 100644
--- a/httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/HttpEntities.java
+++ b/httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/HttpEntities.java
@@ -33,6 +33,7 @@ import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.nio.charset.Charset;
+import java.nio.file.Path;
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.List;
@@ -153,6 +154,10 @@ public final class HttpEntities {
return gzip(create(callback, contentType));
}
+ public static HttpEntity createGzipped(final Path content, final ContentType contentType) {
+ return gzip(create(content, contentType));
+ }
+
public static HttpEntity withTrailers(final HttpEntity entity, final Header... trailers) {
return new HttpEntityWrapper(entity) {
@@ -221,4 +226,12 @@ public final class HttpEntities {
return withTrailers(create(callback, contentType), trailers);
}
+ public static HttpEntity create(final Path content, final ContentType contentType) {
+ return new PathEntity(content, contentType);
+ }
+
+ public static HttpEntity create(final Path content, final ContentType contentType, final Header... trailers) {
+ return withTrailers(create(content, contentType), trailers);
+ }
+
}
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/PathEntity.java b/httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/PathEntity.java
new file mode 100644
index 0000000..7bbd204
--- /dev/null
+++ b/httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/PathEntity.java
@@ -0,0 +1,87 @@
+/*
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF 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.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+
+package org.apache.hc.core5.http.io.entity;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import org.apache.hc.core5.annotation.Contract;
+import org.apache.hc.core5.annotation.ThreadingBehavior;
+import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.util.Args;
+
+/**
+ * A self contained, repeatable entity that obtains its content from a path.
+ */
+@Contract(threading = ThreadingBehavior.IMMUTABLE_CONDITIONAL)
+public class PathEntity extends AbstractHttpEntity {
+
+ private final Path path;
+
+ public PathEntity(final Path path, final ContentType contentType, final String contentEncoding) {
+ super(contentType, contentEncoding);
+ this.path = Args.notNull(path, "Path");
+ }
+
+ public PathEntity(final Path path, final ContentType contentType) {
+ super(contentType, null);
+ this.path = Args.notNull(path, "Path");
+ }
+
+ @Override
+ public final boolean isRepeatable() {
+ return true;
+ }
+
+ @Override
+ public final long getContentLength() {
+ try {
+ return Files.size(this.path);
+ } catch (final IOException e) {
+ throw new IllegalStateException(e);
+ }
+ }
+
+ @Override
+ public final InputStream getContent() throws IOException {
+ return Files.newInputStream(path);
+ }
+
+ @Override
+ public final boolean isStreaming() {
+ return false;
+ }
+
+ @Override
+ public final void close() throws IOException {
+ // do nothing
+ }
+
+}
diff --git a/httpcore5/src/test/java/org/apache/hc/core5/http/io/entity/TestPathEntity.java b/httpcore5/src/test/java/org/apache/hc/core5/http/io/entity/TestPathEntity.java
new file mode 100644
index 0000000..02bed3f
--- /dev/null
+++ b/httpcore5/src/test/java/org/apache/hc/core5/http/io/entity/TestPathEntity.java
@@ -0,0 +1,107 @@
+/*
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF 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.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+
+package org.apache.hc.core5.http.io.entity;
+
+import java.io.ByteArrayOutputStream;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import org.apache.hc.core5.http.ContentType;
+import org.junit.Assert;
+import org.junit.Test;
+
+/**
+ * Unit tests for {@link PathEntity}.
+ */
+public class TestPathEntity {
+
+ @Test
+ public void testBasics() throws Exception {
+ final Path tmpPath = Files.createTempFile("testfile", ".txt");
+ // Mark the file for deletion on VM exit if an assertion fails.
+ tmpPath.toFile().deleteOnExit();
+ try (final PathEntity httpEntity = new PathEntity(tmpPath, ContentType.TEXT_PLAIN)) {
+ Assert.assertEquals(Files.size(tmpPath), httpEntity.getContentLength());
+ try (final InputStream content = httpEntity.getContent()) {
+ Assert.assertNotNull(content);
+ }
+ Assert.assertTrue(httpEntity.isRepeatable());
+ Assert.assertFalse(httpEntity.isStreaming());
+ // If we can't delete the file now, then the PathEntity or test is hanging on to a file handle.
+ if (!Files.deleteIfExists(tmpPath)) {
+ Assert.fail("Failed to delete: " + tmpPath);
+ }
+ }
+ }
+
+ @Test
+ public void testNullConstructor() throws Exception {
+ try (final PathEntity httpEntity = new PathEntity(null, ContentType.TEXT_PLAIN)) {
+ Assert.fail("NullPointerException should have been thrown");
+ } catch (final NullPointerException ex) {
+ // expected
+ }
+ }
+
+ @Test
+ public void testWriteTo() throws Exception {
+ final Path tmpPath = Files.createTempFile("testfile", ".txt");
+ // Mark the file for deletion on VM exit if an assertion fails.
+ tmpPath.toFile().deleteOnExit();
+ try (final OutputStream outStream = Files.newOutputStream(tmpPath)) {
+ outStream.write(0);
+ outStream.write(1);
+ outStream.write(2);
+ outStream.write(3);
+ }
+
+ try (final PathEntity httpEntity = new PathEntity(tmpPath, ContentType.TEXT_PLAIN)) {
+ final ByteArrayOutputStream out = new ByteArrayOutputStream();
+ httpEntity.writeTo(out);
+ final byte[] bytes = out.toByteArray();
+ Assert.assertNotNull(bytes);
+ Assert.assertEquals(Files.size(tmpPath), bytes.length);
+ for (int i = 0; i < 4; i++) {
+ Assert.assertEquals(i, bytes[i]);
+ }
+ // If we can't delete the file now, then the PathEntity or test is hanging on to a file handle
+ if (!Files.deleteIfExists(tmpPath)) {
+ Assert.fail("Failed to delete: " + tmpPath);
+ }
+
+ try {
+ httpEntity.writeTo(null);
+ Assert.fail("NullPointerException should have been thrown");
+ } catch (final NullPointerException ex) {
+ // expected
+ }
+ }
+ }
+}