You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by GitBox <gi...@apache.org> on 2020/08/03 12:21:57 UTC
[GitHub] [httpcomponents-core] carterkozak opened a new pull request #209: HTTPCORE-643 Implement NullEntity for convenience
carterkozak opened a new pull request #209:
URL: https://github.com/apache/httpcomponents-core/pull/209
NullEntity can be used in place of an empty ByteArrayEntity with
no content-type.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] michael-o commented on a change in pull request #209: HTTPCORE-643 Implement NullEntity for convenience
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #209:
URL: https://github.com/apache/httpcomponents-core/pull/209#discussion_r464387518
##########
File path: httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/NullEntity.java
##########
@@ -0,0 +1,115 @@
+/*
+ * ====================================================================
+ * 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 org.apache.hc.core5.annotation.Contract;
+import org.apache.hc.core5.annotation.ThreadingBehavior;
+import org.apache.hc.core5.function.Supplier;
+import org.apache.hc.core5.http.Header;
+import org.apache.hc.core5.http.HttpEntity;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * An empty entity with no content-type. This type may be used for convenience
+ * in place of an empty {@link ByteArrayEntity}.
+ *
+ * @since 5.1
+ */
+@Contract(threading = ThreadingBehavior.IMMUTABLE)
+public final class NullEntity implements HttpEntity {
+
+ public static final NullEntity INSTANCE = new NullEntity();
+
+ private NullEntity() {}
+
+ @Override
+ public boolean isRepeatable() {
+ return true;
+ }
+
+ @Override
+ public InputStream getContent() throws IOException, UnsupportedOperationException {
+ return EmptyInputStream.INSTANCE;
Review comment:
Makes sense in the spirit of consistency.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] ok2c commented on pull request #209: HTTPCORE-643 Implement NullEntity for convenience
Posted by GitBox <gi...@apache.org>.
ok2c commented on pull request #209:
URL: https://github.com/apache/httpcomponents-core/pull/209#issuecomment-668025208
@carterkozak `org.apache.hc.core5.http.io.entity` package ought not have any dependencies on `org.apache.hc.core5.http.impl.io` code. You will have to copy `EmptyInputStream` to `org.apache.hc.core5.http.io.entity`, replace the existing references and deprecate the original class.
No need to write an integration test case.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] carterkozak commented on a change in pull request #209: HTTPCORE-643 Implement NullEntity for convenience
Posted by GitBox <gi...@apache.org>.
carterkozak commented on a change in pull request #209:
URL: https://github.com/apache/httpcomponents-core/pull/209#discussion_r464378750
##########
File path: httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/NullEntity.java
##########
@@ -0,0 +1,115 @@
+/*
+ * ====================================================================
+ * 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 org.apache.hc.core5.annotation.Contract;
+import org.apache.hc.core5.annotation.ThreadingBehavior;
+import org.apache.hc.core5.function.Supplier;
+import org.apache.hc.core5.http.Header;
+import org.apache.hc.core5.http.HttpEntity;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * An empty entity with no content-type. This type may be used for convenience
+ * in place of an empty {@link ByteArrayEntity}.
+ *
+ * @since 5.1
+ */
+@Contract(threading = ThreadingBehavior.IMMUTABLE)
+public final class NullEntity implements HttpEntity {
+
+ public static final NullEntity INSTANCE = new NullEntity();
+
+ private NullEntity() {}
+
+ @Override
+ public boolean isRepeatable() {
+ return true;
+ }
+
+ @Override
+ public InputStream getContent() throws IOException, UnsupportedOperationException {
+ return EmptyInputStream.INSTANCE;
Review comment:
I debated whether to return an empty stream or null here. I expect this to be used as a replacement for an empty ByteArrayEntity in most cases, so I decided to provide the same behavior. Either way should be reasonable though.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] michael-o commented on a change in pull request #209: HTTPCORE-643 Implement NullEntity for convenience
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #209:
URL: https://github.com/apache/httpcomponents-core/pull/209#discussion_r464383194
##########
File path: httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/NullEntity.java
##########
@@ -0,0 +1,115 @@
+/*
+ * ====================================================================
+ * 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 org.apache.hc.core5.annotation.Contract;
+import org.apache.hc.core5.annotation.ThreadingBehavior;
+import org.apache.hc.core5.function.Supplier;
+import org.apache.hc.core5.http.Header;
+import org.apache.hc.core5.http.HttpEntity;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * An empty entity with no content-type. This type may be used for convenience
+ * in place of an empty {@link ByteArrayEntity}.
+ *
+ * @since 5.1
+ */
+@Contract(threading = ThreadingBehavior.IMMUTABLE)
+public final class NullEntity implements HttpEntity {
+
+ public static final NullEntity INSTANCE = new NullEntity();
+
+ private NullEntity() {}
+
+ @Override
+ public boolean isRepeatable() {
+ return true;
+ }
+
+ @Override
+ public InputStream getContent() throws IOException, UnsupportedOperationException {
+ return EmptyInputStream.INSTANCE;
+ }
+
+ @Override
+ public void writeTo(final OutputStream outStream) throws IOException {}
+
+ @Override
+ public boolean isStreaming() {
+ return false;
+ }
+
+ @Override
+ public Supplier<List<? extends Header>> getTrailers() {
+ return null;
+ }
+
+ @Override
+ public void close() throws IOException {}
+
+ @Override
+ public long getContentLength() {
+ return 0;
+ }
+
+ @Override
+ public String getContentType() {
+ return null;
+ }
+
+ @Override
+ public String getContentEncoding() {
+ return null;
+ }
+
+ @Override
+ public boolean isChunked() {
+ return false;
+ }
+
+ @Override
+ public Set<String> getTrailerNames() {
+ return Collections.emptySet();
+ }
+
+ private static final class EmptyInputStream extends InputStream {
Review comment:
I think since this is a `NullEntity` it should have a `NullInputStream` for consistence.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] ok2c commented on pull request #209: HTTPCORE-643 Implement NullEntity for convenience
Posted by GitBox <gi...@apache.org>.
ok2c commented on pull request #209:
URL: https://github.com/apache/httpcomponents-core/pull/209#issuecomment-668012192
@carterkozak Please note there is already `EmptyInputStream` in the `org.apache.hc.core5.http.impl.io` package. We should deprecate it and replace it with the one from `org.apache.hc.core5.http.io.entity` but I can do it afterwards.
@michael-o I think this case is already adequately covered by `TestStandardInterceptors` test class but the more tests cases the better.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] carterkozak commented on pull request #209: HTTPCORE-643 Implement NullEntity for convenience
Posted by GitBox <gi...@apache.org>.
carterkozak commented on pull request #209:
URL: https://github.com/apache/httpcomponents-core/pull/209#issuecomment-668040591
Sounds good, I'll take care of it.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] ok2c merged pull request #209: HTTPCORE-643 Implement NullEntity for convenience
Posted by GitBox <gi...@apache.org>.
ok2c merged pull request #209:
URL: https://github.com/apache/httpcomponents-core/pull/209
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] carterkozak commented on pull request #209: HTTPCORE-643 Implement NullEntity for convenience
Posted by GitBox <gi...@apache.org>.
carterkozak commented on pull request #209:
URL: https://github.com/apache/httpcomponents-core/pull/209#issuecomment-668022638
I'll update this to use the existing EmptyInputStream. Regarding test coverage, simple unit tests to verify content-length zero should fill the gap between the entity and TestStandardInterceptors, otherwise I can write a full integration test later today.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org