Class NStringEntity

    • Constructor Detail

      • NStringEntity

        public NStringEntity​(java.lang.String s,
                             ContentType contentType)
        Creates a NStringEntity with the specified content and content type.
        Parameters:
        s - content to be used. Not null.
        contentType - content type to be used. May be null, in which case ContentType.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. Not null.
        charset - character set to be used. May be null, in which case the default is HTTP.DEF_CONTENT_CHARSET is assumed
        Throws:
        java.lang.IllegalArgumentException - if the string parameter is null
        java.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. Not null.
        charset - character set to be used. May be null, in which case the default is HTTP.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 to ContentType.TEXT_PLAIN.
        Parameters:
        s - content to be used. Not null.
        Throws:
        java.lang.IllegalArgumentException - if the string parameter is null
        java.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 interface HttpAsyncContentProducer
        Specified by:
        isRepeatable in interface HttpEntity
        Returns:
        true if the entity is repeatable, false otherwise.
      • getContentLength

        public long getContentLength()
        Description copied from interface: HttpEntity
        Tells the length of the content, if known.
        Specified by:
        getContentLength in interface HttpEntity
        Returns:
        the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE, a negative number is returned.
      • close

        public void close()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Since:
        4.2
      • finish

        @Deprecated
        public void finish()
        Deprecated.
        (4.2) use close()
        Notification that any resources allocated for writing can be released.
        Specified by:
        finish in interface ProducingNHttpEntity
      • 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 the 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.

        Specified by:
        produceContent in interface HttpAsyncContentProducer
        Specified by:
        produceContent in interface ProducingNHttpEntity
        Parameters:
        encoder - content encoder.
        ioctrl - I/O control of the underlying connection.
        Throws:
        java.io.IOException
      • isStreaming

        public boolean isStreaming()
        Description copied from interface: HttpEntity
        Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should return true. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.
        Specified by:
        isStreaming in interface HttpEntity
        Returns:
        true if the entity content is streamed, false otherwise
      • getContent

        public java.io.InputStream getContent()
        Description copied from interface: HttpEntity
        Returns a content stream of the entity. 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.

        Specified by:
        getContent in interface HttpEntity
        Returns:
        content stream of the entity.
        See Also:
        HttpEntity.isRepeatable()
      • writeTo

        public void writeTo​(java.io.OutputStream outstream)
                     throws java.io.IOException
        Description copied from interface: HttpEntity
        Writes the entity content out to the output stream.

        IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.

        Specified by:
        writeTo in interface HttpEntity
        Parameters:
        outstream - the output stream to write entity content to
        Throws:
        java.io.IOException - if an I/O error occurs