Class EntityTemplate

java.lang.Object
org.apache.http.entity.AbstractHttpEntity
org.apache.http.entity.EntityTemplate
All Implemented Interfaces:
HttpEntity

public class EntityTemplate extends AbstractHttpEntity
Entity that delegates the process of content generation to a ContentProducer.
Since:
4.0
  • Field Details

  • Constructor Details

  • Method Details

    • 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 InputStream getContent() throws 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:
      IOException - if the stream could not be created
      See Also:
    • 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(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.

      Parameters:
      outStream - the output stream to write entity content to
      Throws:
      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