@NotThreadSafe public class InputStreamEntity extends AbstractHttpEntity
InputStream
.chunked, contentEncoding, contentType
Constructor and Description |
---|
InputStreamEntity(InputStream instream,
long length) |
InputStreamEntity(InputStream instream,
long length,
ContentType contentType) |
Modifier and Type | Method and Description |
---|---|
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()
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.
|
getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType
public InputStreamEntity(InputStream instream, long length)
public InputStreamEntity(InputStream instream, long length, ContentType contentType)
public boolean isRepeatable()
HttpEntity
public long getContentLength()
HttpEntity
Long.MAX_VALUE
,
a negative number is returned.public InputStream getContent() throws IOException
HttpEntity
Repeatable
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 createdHttpEntity.isRepeatable()
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 toIOException
- if an I/O error occurspublic boolean isStreaming()
HttpEntity
true
. 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.AbstractHttpEntity
consumeContent
in interface HttpEntity
consumeContent
in class AbstractHttpEntity
IOException
- if an I/O error occurs.and #writeTo(OutputStream)
Copyright © 2005-2015 The Apache Software Foundation. All Rights Reserved.