Package org.apache.hc.core5.http.io.entity

Class HttpEntityWrapper

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, EntityDetails, HttpEntity
    Direct Known Subclasses:
    BufferedHttpEntity
    @Contract(threading=IMMUTABLE_CONDITIONAL)
public class HttpEntityWrapper
extends java.lang.Object
implements HttpEntity
    Base class for wrapping entities that delegates all calls to the wrapped entity. Implementations can derive from this class and override only those methods that should not be delegated to the wrapped entity.
    Since:
    4.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()  
      java.io.InputStream getContent()
      Returns a content stream of the entity.
      java.lang.String getContentEncoding()
      Returns content encoding of the entity, if known.
      long getContentLength()
      Returns length of the entity, if known.
      java.lang.String getContentType()
      Returns content type of the entity, if known.
      java.util.Set<java.lang.String> getTrailerNames()
      Preliminary declaration of trailing headers.
      Supplier<java.util.List<? extends Header>> getTrailers()
      Returns supplier of message trailers - headers sent after message body.
      boolean isChunked()
      Returns chunked transfer hint for this entity.
      boolean isRepeatable()
      Tells if the entity is capable of producing its data more than once.
      boolean isStreaming()
      Tells whether this entity depends on an underlying stream.
      java.lang.String toString()  
      void writeTo​(java.io.OutputStream outStream)
      Writes the entity content out to the output stream.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • wrappedEntity

        private final HttpEntity wrappedEntity
        The wrapped entity.

    • Constructor Detail

      • HttpEntityWrapper

        public HttpEntityWrapper​(HttpEntity wrappedEntity)
        Creates a new entity wrapper.
        Parameters:
        wrappedEntity - the entity to wrap.

    • Method Detail

      • isRepeatable

        public boolean isRepeatable()
        Description copied from interface: HttpEntity
        Tells 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
        Returns 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

      • getContentType

        public java.lang.String getContentType()
        Description copied from interface: EntityDetails
        Returns content type of the entity, if known.
        Specified by:
        getContentType in interface EntityDetails

      • getContentEncoding

        public java.lang.String getContentEncoding()
        Description copied from interface: EntityDetails
        Returns content encoding of the entity, if known.
        Specified by:
        getContentEncoding in interface EntityDetails

      • getContent

        public java.io.InputStream getContent()
                               throws java.io.IOException
        Description copied from interface: HttpEntity
        Returns 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:
        java.io.IOException - if the stream could not be created
        See Also:
        HttpEntity.isRepeatable()

      • writeTo

        public void writeTo​(java.io.OutputStream outStream)
             throws java.io.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:
        java.io.IOException - if an I/O error occurs

      • isStreaming

        public boolean isStreaming()
        Description copied from interface: HttpEntity
        Tells 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

      • getTrailers

        public Supplier<java.util.List<? extends Header>> getTrailers()
        Description copied from interface: HttpEntity
        Returns 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 java.util.Set<java.lang.String> getTrailerNames()
        Description copied from interface: EntityDetails
        Preliminary declaration of trailing headers.
        Specified by:
        getTrailerNames in interface EntityDetails

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object