|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.entity.AbstractHttpEntity
org.apache.http.entity.BasicHttpEntity
@NotThreadSafe public class BasicHttpEntity
A generic streamed, non-repeatable entity that obtains its content
from an InputStream.
| 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()
Deprecated. (4.1) Either use getContent() and call InputStream.close() on that;
otherwise call writeTo(OutputStream) which is required to free the resources. |
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(InputStream instream)
Specifies the content. |
void |
setContentLength(long len)
Specifies the length of the content. |
void |
writeTo(OutputStream outstream)
Writes the entity content out 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 |
|---|
public BasicHttpEntity()
| Method Detail |
|---|
public long getContentLength()
HttpEntity
Long.MAX_VALUE,
a negative number is returned.
public InputStream getContent()
throws IllegalStateException
setContent has been called
IllegalStateException - if the content has not been providedHttpEntity.isRepeatable()public boolean isRepeatable()
falsepublic void setContentLength(long len)
len - the number of bytes in the content, or
a negative number to indicate an unknown lengthpublic void setContent(InputStream instream)
instream - the stream to return with the next call to
getContent
public void writeTo(OutputStream outstream)
throws IOException
HttpEntity
IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
outstream - the output stream to write entity content to
IOException - if an I/O error occurspublic boolean isStreaming()
HttpEntitytrue. Self-contained entities should return
false. Wrapping entities should delegate this call
to the wrapped entity.
true if the entity content is streamed,
false otherwise
@Deprecated
public void consumeContent()
throws IOException
getContent() and call InputStream.close() on that;
otherwise call writeTo(OutputStream) which is required to free the resources.
consumeContent in interface HttpEntityconsumeContent in class AbstractHttpEntityIOException - if an I/O error occurs.and #writeTo(OutputStream)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||