@Contract(threading=IMMUTABLE_CONDITIONAL) public class SerializableEntity extends AbstractHttpEntity
Serializable.| Constructor and Description |
|---|
SerializableEntity(Serializable serializable,
ContentType contentType)
Creates new instance of this class.
|
SerializableEntity(Serializable serializable,
ContentType contentType,
String contentEncoding)
Creates new instance of this class.
|
| Modifier and Type | Method and Description |
|---|---|
void |
close() |
InputStream |
getContent()
Returns a content stream of the entity.
|
long |
getContentLength()
Returns length of the entity, 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.
|
getContentEncoding, getContentType, getTrailerNames, getTrailers, isChunked, toString, writeTopublic SerializableEntity(Serializable serializable, ContentType contentType, String contentEncoding)
serializable - the serializable object.contentType - the content type.contentEncoding - the content encoding.public SerializableEntity(Serializable serializable, ContentType contentType)
serializable - the serializable object.contentType - the content type.public final 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.
If this entity belongs to an incoming HTTP message, calling
InputStream.close() on the returned InputStream will
try to consume the complete entity content to keep the connection
alive. In cases where this is undesired, e.g. when only a small part
of the content is relevant and consuming the complete entity content
would be too inefficient, only the HTTP message from which
this entity was obtained should be closed (if supported).
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 final long getContentLength()
EntityDetailspublic final boolean isRepeatable()
HttpEntityisRepeatable in interface HttpEntityisRepeatable in class AbstractHttpEntitypublic final 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 final 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.
writeTo in interface HttpEntitywriteTo in class AbstractHttpEntityoutStream - the output stream to write entity content toIOException - if an I/O error occurspublic final void close()
throws IOException
IOExceptionCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.