org.apache.http.entity
Class BasicHttpEntity

java.lang.Object
  org.apache.http.entity.AbstractHttpEntity
      org.apache.http.entity.BasicHttpEntity

All Implemented Interfaces:

HttpEntity

public class BasicHttpEntity

extends AbstractHttpEntity

A generic streamed entity being received on a connection.

Since:

4.0

Version:

$Revision: 496070 $

Author:

Oleg Kalnichevski

Field Summary

Fields inherited from class org.apache.http.entity.AbstractHttpEntity

chunked, contentEncoding, contentType

Constructor Summary

BasicHttpEntity()
Creates a new basic entity.

Method Summary

void	consumeContent() Does not consume anything.
java.io.InputStream	getContent() Obtains the content, once only.
long	getContentLength() Tells the length of the content, if known.
boolean	isRepeatable() Tells that this entity is not repeatable.
boolean	isStreaming() Tells whether this entity depends on an underlying stream.
void	setContent(java.io.InputStream instream) Specifies the content.
void	setContentLength(long len) Specifies the length of the content.
void	writeTo(java.io.OutputStream outstream) Writes the entity content to the output stream.

Methods inherited from class org.apache.http.entity.AbstractHttpEntity

getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHttpEntity

public BasicHttpEntity()

Creates a new basic entity. The content is initially missing, the content length is set to a negative number.

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.lang.IllegalStateException

Obtains the content, once only.

Returns:

the content, if this is the first call to this method since setContent has been called

Throws:

java.lang.IllegalStateException - if the content has been obtained before, or has not yet been provided

isRepeatable

public boolean isRepeatable()

Tells that this entity is not repeatable.

Returns:

false

setContentLength

public void setContentLength(long len)

Specifies the length of the content.

Parameters:

len - the number of bytes in the content, or a negative number to indicate an unknown length

setContent

public void setContent(java.io.InputStream instream)

Specifies the content.

Parameters:

instream - the stream to return with the next call to getContent

writeTo

public void writeTo(java.io.OutputStream outstream)
             throws java.io.IOException

Description copied from interface: HttpEntity

Writes the entity content to the output stream.

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 should return true until the content has been consumed, false afterwards. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.
The content of a streamed entity is consumed when the stream returned by getContent has been read to EOF, or after consumeContent has been called. If a streamed entity can not detect whether the stream has been read to EOF, it should return true until consumeContent is called.

Returns:

true if the entity content is streamed and not yet consumed, false otherwise

consumeContent

public void consumeContent()
                    throws java.io.IOException

Description copied from class: AbstractHttpEntity

Does not consume anything. The default implementation does nothing if isStreaming returns false, and throws an exception if it returns true. This removes the burden of implementing an empty method for non-streaming entities.

Specified by:

consumeContent in interface HttpEntity

Overrides:

consumeContent in class AbstractHttpEntity

Throws:

java.io.IOException - in case of an I/O problem