Class BasicHttpEntity

java.lang.Object
org.apache.hc.core5.http.io.entity.AbstractHttpEntity
org.apache.hc.core5.http.io.entity.BasicHttpEntity
All Implemented Interfaces:
Closeable, AutoCloseable, EntityDetails, HttpEntity
@Contract(threading=IMMUTABLE_CONDITIONAL) public class BasicHttpEntity extends AbstractHttpEntity
A generic streamed, non-repeatable entity that obtains its content from an InputStream.

This class contains immutable attributes but subclasses may contain additional immutable or mutable attributes.

Since:
4.0
See Also:

  • Field Details

    • content

      private final InputStream content

    • length

      private final long length

  • Constructor Details

    • BasicHttpEntity

      public BasicHttpEntity(InputStream content, long contentLength, ContentType contentType, String contentEncoding, boolean chunked)
      Constructs a new instance with the given attributes kept as immutable.
      Parameters:
      content - The message body contents as an InputStream.
      contentLength - The value for the Content-Length header for the size of the message body, in bytes.
      contentType - The content-type, may be null.
      contentEncoding - The content encoding string, may be null.
      chunked - Whether this entity should be chunked.

    • BasicHttpEntity

      public BasicHttpEntity(InputStream content, long contentLength, ContentType contentType, String contentEncoding)
      Constructs a new instance with the given attributes kept as immutable.

      The new instance:

      • is not chunked.
      Parameters:
      content - The message body contents as an InputStream.
      contentLength - The value for the Content-Length header for the size of the message body, in bytes.
      contentType - The content-type, may be null.
      contentEncoding - The content encoding string, may be null.

    • BasicHttpEntity

      public BasicHttpEntity(InputStream content, long contentLength, ContentType contentType)
      Constructs a new instance with the given attributes kept as immutable.

      The new instance:

      • is not chunked.
      • does not define a content encoding.
      Parameters:
      content - The message body contents as an InputStream.
      contentLength - The value for the Content-Length header for the size of the message body, in bytes.
      contentType - The content-type, may be null.

    • BasicHttpEntity

      public BasicHttpEntity(InputStream content, ContentType contentType, String contentEncoding)
      Constructs a new instance with the given attributes kept as immutable.

      The new instance:

      • is not chunked.
      • does not define a length.
      Parameters:
      content - The message body contents as an InputStream.
      contentType - The content-type, may be null.
      contentEncoding - The content encoding string, may be null.

    • BasicHttpEntity

      public BasicHttpEntity(InputStream content, ContentType contentType)
      Constructs a new instance with the given attributes kept as immutable.

      The new instance:

      • is not chunked.
      • does not define a length.
      • does not define a content encoding.
      Parameters:
      content - The message body contents as an InputStream.
      contentType - The content-type, may be null.

    • BasicHttpEntity

      public BasicHttpEntity(InputStream content, ContentType contentType, boolean chunked)
      Constructs a new instance with the given attributes kept as immutable.

      The new instance:

      • does not define a length.
      • does not define a content encoding.
      Parameters:
      content - The message body contents as an InputStream.
      contentType - The content-type, may be null.
      chunked - Whether this entity should be chunked.

  • Method Details

    • getContentLength

      public final long getContentLength()
      Description copied from interface: EntityDetails
      Gets length of this entity, if known.
      Returns:
      the length of this entity, may be 0.

    • getContent

      public final InputStream getContent() throws IllegalStateException
      Description copied from interface: HttpEntity
      Gets a content stream of the entity. Repeatable entities are expected to create a new instance of InputStream for each invocation of this method and therefore can be consumed multiple times. Entities that are not repeatable are expected to return the same InputStream instance and therefore may not be consumed more than once.

      If this entity belongs to an incoming HTTP message, calling InputStream.close() on the returned InputStream will try to consume the complete entity content to keep the connection alive. In cases where this is undesired, e.g. when only a small part of the content is relevant and consuming the complete entity content would be too inefficient, only the HTTP message from which this entity was obtained should be closed (if supported).

      IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated after the InputStream.close() method is invoked.

      Returns:
      content stream of the entity.
      Throws:
      IllegalStateException
      See Also:

    • isRepeatable

      public final boolean isRepeatable()
      Tests if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.

      This implementation always returns false.

      This implementation always returns false.

      Specified by:
      isRepeatable in interface HttpEntity
      Overrides:
      isRepeatable in class AbstractHttpEntity
      Returns:
      true if the entity is repeatable, false otherwise.

    • isStreaming

      public final boolean isStreaming()
      Tests whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should return true. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.

      This implementation always returns true.

      Returns:
      true if the entity content is streamed, false otherwise

    • close

      public final void close() throws IOException
      Throws:
      IOException