Package org.apache.http.nio.entity
Class NStringEntity
- java.lang.Object
-
- org.apache.http.entity.AbstractHttpEntity
-
- org.apache.http.nio.entity.NStringEntity
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,org.apache.http.HttpEntity
,HttpAsyncContentProducer
,ProducingNHttpEntity
public class NStringEntity extends org.apache.http.entity.AbstractHttpEntity implements HttpAsyncContentProducer, ProducingNHttpEntity
A simple, self contained, repeatable non-blocking entity that retrieves its content from aString
object.- Since:
- 4.0
-
-
Constructor Summary
Constructors Constructor Description NStringEntity(java.lang.String s)
Creates a NStringEntity with the specified content.NStringEntity(java.lang.String s, java.lang.String charset)
Creates a NStringEntity with the specified content and charset.NStringEntity(java.lang.String s, java.nio.charset.Charset charset)
Creates a NStringEntity with the specified content and charset.NStringEntity(java.lang.String s, org.apache.http.entity.ContentType contentType)
Creates a NStringEntity with the specified content and content type.
-
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 ioControl)
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
-
NStringEntity
public NStringEntity(java.lang.String s, org.apache.http.entity.ContentType contentType)
Creates a NStringEntity with the specified content and content type.- Parameters:
s
- content to be used. Notnull
.contentType
- content type to be used. May benull
, in which caseContentType.TEXT_PLAIN
is assumed.- Throws:
java.lang.IllegalArgumentException
- if the string parameter is null- Since:
- 4.2
-
NStringEntity
public NStringEntity(java.lang.String s, java.lang.String charset) throws java.io.UnsupportedEncodingException
Creates a NStringEntity with the specified content and charset. The MIME type defaults to "text/plain".- Parameters:
s
- content to be used. Notnull
.charset
- character set to be used. May benull
, in which case the default isHTTP.DEF_CONTENT_CHARSET
is assumed- Throws:
java.lang.IllegalArgumentException
- if the string parameter is nulljava.io.UnsupportedEncodingException
- Thrown when the named charset is not available in this instance of the Java virtual machine
-
NStringEntity
public NStringEntity(java.lang.String s, java.nio.charset.Charset charset)
Creates a NStringEntity with the specified content and charset. The MIME type defaults to "text/plain".- Parameters:
s
- content to be used. Notnull
.charset
- character set to be used. May benull
, in which case the default isHTTP.DEF_CONTENT_CHARSET
is assumed- Throws:
java.lang.IllegalArgumentException
- if the string parameter is null- Since:
- 4.2
-
NStringEntity
public NStringEntity(java.lang.String s) throws java.io.UnsupportedEncodingException
Creates a NStringEntity with the specified content. The content type defaults toContentType.TEXT_PLAIN
.- Parameters:
s
- content to be used. Notnull
.- Throws:
java.lang.IllegalArgumentException
- if the string parameter is nulljava.io.UnsupportedEncodingException
- if the default HTTP charset is not supported.
-
-
Method Detail
-
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
-
getContentLength
public long getContentLength()
- Specified by:
getContentLength
in interfaceorg.apache.http.HttpEntity
-
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 ioControl) 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.ioControl
- I/O control of the underlying connection.- Throws:
java.io.IOException
-
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
-
-