public class SerializableEntity extends AbstractHttpEntity
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.chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE| Constructor and Description |
|---|
SerializableEntity(Serializable serializable)
Creates new instance of this class.
|
SerializableEntity(Serializable ser,
boolean bufferize)
Creates new instance of this class.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toStringpublic SerializableEntity(Serializable ser, boolean bufferize) throws IOException
ser - inputbufferize - tells whether the content should be
stored in an internal bufferIOException - in case of an I/O errorpublic SerializableEntity(Serializable serializable)
serializable - The object to serialize.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 createdIllegalStateExceptionHttpEntity.isRepeatable()public long getContentLength()
HttpEntityLong.MAX_VALUE,
a negative number is returned.public boolean isRepeatable()
HttpEntitypublic 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 otherwisepublic 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 toIOException - if an I/O error occursCopyright © 2005–2022 The Apache Software Foundation. All rights reserved.