Package org.apache.http.entity

Class EntityTemplate

    • Constructor Detail

      • EntityTemplate

        public EntityTemplate​(ContentProducer contentproducer)

    • Method Detail

      • getContentLength

        public long getContentLength()
        Description copied from interface: HttpEntity
        Tells the length of the content, if known.
        Returns:
        the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE, a negative number is returned.

      • 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.

        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:
        java.io.IOException - if the stream could not be created
        See Also:
        HttpEntity.isRepeatable()

      • 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.
        Returns:
        true if the entity is repeatable, false otherwise.

      • 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.

        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.
        Returns:
        true if the entity content is streamed, false otherwise