|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.entity.AbstractHttpEntity
org.apache.http.nio.entity.NByteArrayEntity
public class NByteArrayEntity
A simple self contained, repeatable non-blocking entity that retrieves its content from a byte array.
Field Summary | |
---|---|
protected ByteBuffer |
buffer
Deprecated. (4.2) |
protected byte[] |
content
Deprecated. (4.2) |
Fields inherited from class org.apache.http.entity.AbstractHttpEntity |
---|
chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE |
Constructor Summary | |
---|---|
NByteArrayEntity(byte[] b)
|
|
NByteArrayEntity(byte[] b,
ContentType contentType)
|
|
NByteArrayEntity(byte[] b,
int off,
int len)
|
|
NByteArrayEntity(byte[] b,
int off,
int len,
ContentType contentType)
|
Method Summary | |
---|---|
void |
close()
|
void |
finish()
Deprecated. (4.2) use close() |
InputStream |
getContent()
Returns a content stream of the entity. |
long |
getContentLength()
Tells the length of the content, if known. |
boolean |
isRepeatable()
Determines whether or not this producer is capable of producing its content more than once. |
boolean |
isStreaming()
Tells whether this entity depends on an underlying stream. |
void |
produceContent(ContentEncoder encoder,
IOControl ioControl)
Invoked to write out a chunk of content to the ContentEncoder . |
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.http.HttpEntity |
---|
consumeContent, getContentEncoding, getContentType, isChunked |
Field Detail |
---|
@Deprecated protected final byte[] content
@Deprecated protected final ByteBuffer buffer
Constructor Detail |
---|
public NByteArrayEntity(byte[] b, ContentType contentType)
public NByteArrayEntity(byte[] b, int off, int len, ContentType contentType)
public NByteArrayEntity(byte[] b)
public NByteArrayEntity(byte[] b, int off, int len)
Method Detail |
---|
public void close()
close
in interface Closeable
@Deprecated public void finish()
close()
finish
in interface ProducingNHttpEntity
public void produceContent(ContentEncoder encoder, IOControl ioControl) throws IOException
HttpAsyncContentProducer
ContentEncoder
.
The IOControl
interface can be used to suspend output event
notifications if the entity is temporarily unable to produce more content.
When all content is finished, the producer MUST call
ContentEncoder.complete()
. Failure to do so may cause the entity
to be incorrectly delimited.
Please note that the ContentEncoder
object is not thread-safe and
should only be used within the context of this method call.
The IOControl
object can be shared and used on other thread
to resume output event notifications when more content is made available.
produceContent
in interface HttpAsyncContentProducer
produceContent
in interface ProducingNHttpEntity
encoder
- content encoder.ioControl
- I/O control of the underlying connection.
IOException
public long getContentLength()
HttpEntity
getContentLength
in interface HttpEntity
Long.MAX_VALUE
,
a negative number is returned.public boolean isRepeatable()
HttpAsyncContentProducer
isRepeatable
in interface HttpEntity
isRepeatable
in interface HttpAsyncContentProducer
public boolean isStreaming()
HttpEntity
true
. Self-contained entities should return
false
. Wrapping entities should delegate this call
to the wrapped entity.
isStreaming
in interface HttpEntity
true
if the entity content is streamed,
false
otherwisepublic InputStream getContent()
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.
getContent
in interface HttpEntity
HttpEntity.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.
writeTo
in interface HttpEntity
outStream
- the output stream to write entity content to
IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |