Class IncomingHttpEntity

java.lang.Object
org.apache.hc.core5.http.impl.io.support.IncomingHttpEntity
All Implemented Interfaces:
Closeable, AutoCloseable, EntityDetails, HttpEntity
@Internal public class IncomingHttpEntity extends Object implements HttpEntity

  • Field Details

    • content

      private final InputStream content

    • len

      private final long len

    • message

      private final HttpMessage message

  • Constructor Details

  • Method Details

    • isRepeatable

      public boolean isRepeatable()
      Description copied from interface: HttpEntity
      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.
      Specified by:
      isRepeatable in interface HttpEntity
      Returns:
      true if the entity is repeatable, false otherwise.

    • isChunked

      public boolean isChunked()
      Description copied from interface: EntityDetails
      Tests the chunked transfer hint for this entity.

      The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

      Specified by:
      isChunked in interface EntityDetails
      Returns:
      the chunked transfer hint for this entity.

    • getContentLength

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

    • getContentType

      public String getContentType()
      Description copied from interface: EntityDetails
      Gets content type of this entity, if known.
      Specified by:
      getContentType in interface EntityDetails
      Returns:
      the content type of this entity, may be null.

    • getContentEncoding

      public String getContentEncoding()
      Description copied from interface: EntityDetails
      Gets content encoding of this entity, if known.
      Specified by:
      getContentEncoding in interface EntityDetails
      Returns:
      the content encoding of this entity, may be null.

    • getContent

      public InputStream getContent() throws IOException, 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.

      Specified by:
      getContent in interface HttpEntity
      Returns:
      content stream of the entity.
      Throws:
      IOException - if the stream could not be created
      IllegalStateException
      See Also:

    • isStreaming

      public boolean isStreaming()
      Description copied from interface: HttpEntity
      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.
      Specified by:
      isStreaming in interface HttpEntity
      Returns:
      true if the entity content is streamed, false otherwise

    • writeTo

      public void writeTo(OutputStream outStream) throws IOException
      Description copied from interface: HttpEntity
      Writes the entity content out to the output stream.

      IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.

      Specified by:
      writeTo in interface HttpEntity
      Parameters:
      outStream - the output stream to write entity content to
      Throws:
      IOException - if an I/O error occurs

    • getTrailers

      public Supplier<List<? extends Header>> getTrailers()
      Description copied from interface: HttpEntity
      Gets supplier of message trailers - headers sent after message body. May return null if trailers are not available.
      Specified by:
      getTrailers in interface HttpEntity

    • getTrailerNames

      public Set<String> getTrailerNames()
      Description copied from interface: EntityDetails
      Gets the preliminary declaration of trailing headers.
      Specified by:
      getTrailerNames in interface EntityDetails
      Returns:
      the preliminary declaration of trailing headers.

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object