| 
 | ||||||||||
| 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.SerializableEntity
public class SerializableEntity
A streamed entity that obtains its content from a Serializable.
 The content obtained from the Serializable instance can
 optionally be buffered in a byte array in order to make the
 entity self-contained and repeatable.
| Field Summary | 
|---|
| Fields inherited from class org.apache.http.entity.AbstractHttpEntity | 
|---|
| chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE | 
| Constructor Summary | |
|---|---|
| SerializableEntity(Serializable serializable)Creates new instance of this class. | |
| SerializableEntity(Serializable ser,
                   boolean bufferize)Creates new instance of this class. | |
| Method Summary | |
|---|---|
|  InputStream | getContent()Returns a content stream of the entity. | 
|  long | getContentLength()Tells the length of the content, if known. | 
|  boolean | isRepeatable()Tells if the entity is capable of producing its data more than once. | 
|  boolean | isStreaming()Tells whether this entity depends on an underlying stream. | 
|  void | writeTo(OutputStream outStream)Writes the entity content out to the output stream. | 
| Methods inherited from class org.apache.http.entity.AbstractHttpEntity | 
|---|
| consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toString | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Constructor Detail | 
|---|
public SerializableEntity(Serializable ser,
                          boolean bufferize)
                   throws IOException
ser - inputbufferize - tells whether the content should be
        stored in an internal buffer
IOException - in case of an I/O errorpublic SerializableEntity(Serializable serializable)
serializable - The object to serialize.| Method Detail | 
|---|
public InputStream getContent()
                       throws IOException,
                              IllegalStateException
HttpEntityRepeatable 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.
IOException - if the stream could not be created
IllegalStateExceptionHttpEntity.isRepeatable()public long getContentLength()
HttpEntity
Long.MAX_VALUE,
          a negative number is returned.public boolean isRepeatable()
HttpEntity
public 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
public void writeTo(OutputStream outStream)
             throws IOException
HttpEntityIMPORTANT: 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 occurs| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||