public class InputStreamEntity extends AbstractHttpEntity
InputStream
.chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE
Constructor and Description |
---|
InputStreamEntity(InputStream inStream)
Creates an entity with an unknown length.
|
InputStreamEntity(InputStream inStream,
ContentType contentType)
Creates an entity with a content type and unknown length.
|
InputStreamEntity(InputStream inStream,
long length)
Creates an entity with a specified content length.
|
InputStreamEntity(InputStream inStream,
long length,
ContentType contentType) |
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 bytes from the
InputStream this entity was constructed
with to an OutputStream . |
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toString
public InputStreamEntity(InputStream inStream)
new InputStreamEntity(inStream, -1)
.inStream
- input streamIllegalArgumentException
- if inStream
is null
public InputStreamEntity(InputStream inStream, long length)
inStream
- input streamlength
- of the input stream, -1
if unknownIllegalArgumentException
- if inStream
is null
public InputStreamEntity(InputStream inStream, ContentType contentType)
new InputStreamEntity(inStream, -1, contentType)
.inStream
- input streamcontentType
- content typeIllegalArgumentException
- if inStream
is null
public InputStreamEntity(InputStream inStream, long length, ContentType contentType)
inStream
- input streamlength
- of the input stream, -1
if unknowncontentType
- for specifying the Content-Type
header, may be null
IllegalArgumentException
- if inStream
is null
public boolean isRepeatable()
HttpEntity
public long getContentLength()
HttpEntity
-1
if unknownpublic 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
InputStream
this entity was constructed
with to an OutputStream
. The content length
determines how many bytes are written. If the length is unknown (-1
), the
stream will be completely consumed (to the end of the stream).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
otherwiseCopyright © 2005–2022 The Apache Software Foundation. All rights reserved.