Package org.apache.http.entity
Class SerializableEntity
java.lang.Object
org.apache.http.entity.AbstractHttpEntity
org.apache.http.entity.SerializableEntity
- All Implemented Interfaces:
HttpEntity
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.- Since:
- 4.0
-
Field Summary
FieldsFields inherited from class org.apache.http.entity.AbstractHttpEntity
chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE
-
Constructor Summary
ConstructorsConstructorDescriptionSerializableEntity
(Serializable serializable) Creates new instance of this class.SerializableEntity
(Serializable ser, boolean bufferize) Creates new instance of this class. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
createBytes
(Serializable ser) Returns a content stream of the entity.long
Tells the length of the content, if known.boolean
Tells if the entity is capable of producing its data more than once.boolean
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
-
Field Details
-
objSer
private byte[] objSer -
objRef
-
-
Constructor Details
-
SerializableEntity
Creates new instance of this class.- Parameters:
ser
- inputbufferize
- tells whether the content should be stored in an internal buffer- Throws:
IOException
- in case of an I/O error
-
SerializableEntity
Creates new instance of this class.- Parameters:
serializable
- The object to serialize.- Since:
- 4.3
-
-
Method Details
-
createBytes
- Throws:
IOException
-
getContent
Description copied from interface:HttpEntity
Returns a content stream of the entity.Repeatable
entities are expected to create a new instance ofInputStream
for each invocation of this method and therefore can be consumed multiple times. Entities that are notrepeatable
are expected to return the sameInputStream
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.- Returns:
- content stream of the entity.
- Throws:
IOException
- if the stream could not be createdIllegalStateException
- See Also:
-
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.
-
isRepeatable
public boolean isRepeatable()Description copied from interface:HttpEntity
Tells if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.- Returns:
- true if the entity is repeatable, false otherwise.
-
isStreaming
public boolean isStreaming()Description copied from interface:HttpEntity
Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should returntrue
. Self-contained entities should returnfalse
. Wrapping entities should delegate this call to the wrapped entity.- Returns:
true
if the entity content is streamed,false
otherwise
-
writeTo
Description copied from interface:HttpEntity
Writes the entity content out to the output stream.IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
- Parameters:
outStream
- the output stream to write entity content to- Throws:
IOException
- if an I/O error occurs
-