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

Class BufferedHttpEntity

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, EntityDetails, HttpEntity
    public class BufferedHttpEntity
extends HttpEntityWrapper
    A wrapping entity that buffers it content if necessary. The buffered entity is always repeatable. If the wrapped entity is repeatable itself, calls are passed through. If the wrapped entity is not repeatable, the content is read into a buffer once and provided from there as often as required.
    Since:
    4.0

    • Field Detail

      • buffer

        private final byte[] buffer

    • Constructor Detail

      • BufferedHttpEntity

        public BufferedHttpEntity​(HttpEntity entity)
                   throws java.io.IOException
        Creates a new buffered entity wrapper.
        Parameters:
        entity - the entity to wrap, not null
        Throws:
        java.lang.IllegalArgumentException - if wrapped is null
        java.io.IOException

    • Method Detail

      • 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
        Overrides:
        getContent in class HttpEntityWrapper
        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
        Overrides:
        writeTo in class HttpEntityWrapper
        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
        Overrides:
        isStreaming in class HttpEntityWrapper
        Returns:
        true if the entity content is streamed, false otherwise