|
||||||||||
| 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.NStringEntity
public class NStringEntity
A simple, self contained, repeatable non-blocking entity that retrieves
its content from a String object.
| 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 | |
|---|---|
NStringEntity(String s)
Creates a NStringEntity with the specified content. |
|
NStringEntity(String s,
Charset charset)
Creates a NStringEntity with the specified content and charset. |
|
NStringEntity(String s,
ContentType contentType)
Creates a NStringEntity with the specified content and content type. |
|
NStringEntity(String s,
String charset)
Creates a NStringEntity with the specified content and charset. |
|
| 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 NStringEntity(String s,
ContentType contentType)
s - content to be used. Not null.contentType - content type to be used. May be null, in which case
ContentType.TEXT_PLAIN is assumed.
IllegalArgumentException - if the string parameter is null
public NStringEntity(String s,
String charset)
throws UnsupportedEncodingException
s - content to be used. Not null.charset - character set to be used. May be null, in which case the default
is HTTP.DEF_CONTENT_CHARSET is assumed
IllegalArgumentException - if the string parameter is null
UnsupportedEncodingException - Thrown when the named charset is not available in
this instance of the Java virtual machine
public NStringEntity(String s,
Charset charset)
s - content to be used. Not null.charset - character set to be used. May be null, in which case the default
is HTTP.DEF_CONTENT_CHARSET is assumed
IllegalArgumentException - if the string parameter is null
public NStringEntity(String s)
throws UnsupportedEncodingException
ContentType.TEXT_PLAIN.
s - content to be used. Not null.
IllegalArgumentException - if the string parameter is null
UnsupportedEncodingException - if the default HTTP charset is not supported.| Method Detail |
|---|
public boolean isRepeatable()
HttpAsyncContentProducer
isRepeatable in interface HttpEntityisRepeatable in interface HttpAsyncContentProducerpublic long getContentLength()
HttpEntity
getContentLength in interface HttpEntityLong.MAX_VALUE,
a negative number is returned.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
HttpAsyncContentProducerContentEncoder.
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 HttpAsyncContentProducerproduceContent in interface ProducingNHttpEntityencoder - content encoder.ioControl - I/O control of the underlying connection.
IOExceptionpublic boolean isStreaming()
HttpEntitytrue. Self-contained entities should return
false. Wrapping entities should delegate this call
to the wrapped entity.
isStreaming in interface HttpEntitytrue if the entity content is streamed,
false otherwisepublic InputStream getContent()
HttpEntityRepeatable 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 HttpEntityHttpEntity.isRepeatable()
public void writeTo(OutputStream outStream)
throws IOException
HttpEntityIMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo in interface HttpEntityoutStream - 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 | |||||||||