Package org.apache.http.nio.entity
Class NByteArrayEntity
- java.lang.Object
-
- org.apache.http.entity.AbstractHttpEntity
-
- org.apache.http.nio.entity.NByteArrayEntity
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,org.apache.http.HttpEntity
,HttpAsyncContentProducer
,ProducingNHttpEntity
public class NByteArrayEntity extends org.apache.http.entity.AbstractHttpEntity implements HttpAsyncContentProducer, ProducingNHttpEntity
A simple self contained, repeatable non-blocking entity that retrieves its content from a byte array.- Since:
- 4.0
-
-
Constructor Summary
Constructors Constructor Description NByteArrayEntity(byte[] b)
NByteArrayEntity(byte[] b, int off, int len)
NByteArrayEntity(byte[] b, int off, int len, org.apache.http.entity.ContentType contentType)
NByteArrayEntity(byte[] b, org.apache.http.entity.ContentType contentType)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
close()
void
finish()
Deprecated.(4.2) useclose()
java.io.InputStream
getContent()
long
getContentLength()
boolean
isRepeatable()
Determines whether or not this producer is capable of producing its content more than once.boolean
isStreaming()
void
produceContent(ContentEncoder encoder, IOControl ioctrl)
Invoked to write out a chunk of content to theContentEncoder
.void
writeTo(java.io.OutputStream outstream)
-
Methods inherited from class org.apache.http.entity.AbstractHttpEntity
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toString
-
-
-
-
Constructor Detail
-
NByteArrayEntity
public NByteArrayEntity(byte[] b, org.apache.http.entity.ContentType contentType)
- Since:
- 4.2
-
NByteArrayEntity
public NByteArrayEntity(byte[] b, int off, int len, org.apache.http.entity.ContentType contentType)
- Since:
- 4.2
-
NByteArrayEntity
public NByteArrayEntity(byte[] b)
-
NByteArrayEntity
public NByteArrayEntity(byte[] b, int off, int len)
-
-
Method Detail
-
close
public void close()
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Since:
- 4.2
-
finish
@Deprecated public void finish()
Deprecated.(4.2) useclose()
Notification that any resources allocated for writing can be released.- Specified by:
finish
in interfaceProducingNHttpEntity
-
produceContent
public void produceContent(ContentEncoder encoder, IOControl ioctrl) throws java.io.IOException
Description copied from interface:HttpAsyncContentProducer
Invoked to write out a chunk of content to theContentEncoder
. TheIOControl
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. TheIOControl
object can be shared and used on other thread to resume output event notifications when more content is made available.- Specified by:
produceContent
in interfaceHttpAsyncContentProducer
- Specified by:
produceContent
in interfaceProducingNHttpEntity
- Parameters:
encoder
- content encoder.ioctrl
- I/O control of the underlying connection.- Throws:
java.io.IOException
-
getContentLength
public long getContentLength()
- Specified by:
getContentLength
in interfaceorg.apache.http.HttpEntity
-
isRepeatable
public boolean isRepeatable()
Description copied from interface:HttpAsyncContentProducer
Determines whether or not this producer is capable of producing its content more than once. Repeatable content producers are expected to be able to recreate their content even after having been closed.- Specified by:
isRepeatable
in interfaceHttpAsyncContentProducer
- Specified by:
isRepeatable
in interfaceorg.apache.http.HttpEntity
-
isStreaming
public boolean isStreaming()
- Specified by:
isStreaming
in interfaceorg.apache.http.HttpEntity
-
getContent
public java.io.InputStream getContent()
- Specified by:
getContent
in interfaceorg.apache.http.HttpEntity
-
writeTo
public void writeTo(java.io.OutputStream outstream) throws java.io.IOException
- Specified by:
writeTo
in interfaceorg.apache.http.HttpEntity
- Throws:
java.io.IOException
-
-