org.apache.hc.core5.http.io.entity

Class StringEntity

java.lang.Object

org.apache.hc.core5.http.io.entity.AbstractHttpEntity

org.apache.hc.core5.http.io.entity.StringEntity

All Implemented Interfaces:

Closeable, AutoCloseable, EntityDetails, HttpEntity

@Contract(threading=IMMUTABLE)
public class StringEntity
extends AbstractHttpEntity

A self contained, repeatable entity that obtains its content from a String.

This class contains immutable attributes but subclasses may contain additional immutable or mutable attributes.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
StringEntity(String string) Constructs a StringEntity with the specified content and content type.
StringEntity(String string, Charset charset) Constructs a StringEntity with the specified content and charset.
StringEntity(String string, Charset charset, boolean chunked) Constructs a StringEntity with the specified content and content type.
StringEntity(String string, ContentType contentType) Constructs a StringEntity with the specified content and content type.
StringEntity(String string, ContentType contentType, boolean chunked) Constructs a StringEntity with the specified content and content type.
StringEntity(String string, ContentType contentType, String contentEncoding, boolean chunked) Constructs a StringEntity with the specified content and content type.

Method Summary

Modifier and Type	Method and Description
void	close()
InputStream	getContent() Gets a content stream of the entity.
long	getContentLength() Gets length of this entity, if known.
boolean	isRepeatable() Tests if the entity is capable of producing its data more than once.
boolean	isStreaming() Tests whether this entity depends on an underlying stream.
void	writeTo(OutputStream outStream) Writes this entity to an OutputStream.

Methods inherited from class org.apache.hc.core5.http.io.entity.AbstractHttpEntity

getContentEncoding, getContentType, getTrailerNames, getTrailers, isChunked, toString, writeTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringEntity

public StringEntity(String string,
                    ContentType contentType,
                    String contentEncoding,
                    boolean chunked)

Constructs a StringEntity with the specified content and content type.

Parameters:

string - The content to be used. Not null.

contentType - The content type to be used. May be null, in which case the default MIME type ContentType.TEXT_PLAIN is assumed.

contentEncoding - The content encoding string, may be null.

chunked - Whether this entity should be chunked.

Throws:

NullPointerException - Thrown if string is null.

Since:

5.0

StringEntity

public StringEntity(String string,
                    ContentType contentType,
                    boolean chunked)

Constructs a StringEntity with the specified content and content type.

The new instance:

• does not define a content encoding.

Parameters:

string - The content to be used. Not null.

contentType - The content type to be used. May be null, in which case the default MIME type ContentType.TEXT_PLAIN is assumed.

chunked - Whether this entity should be chunked.

Throws:

NullPointerException - Thrown if string is null.

StringEntity

public StringEntity(String string,
                    ContentType contentType)

Constructs a StringEntity with the specified content and content type.

The new instance:

• is not chunked.
• does not define a content encoding.

Parameters:

string - The content to be used. Not null.

contentType - The content type to be used. May be null, in which case the default MIME type ContentType.TEXT_PLAIN is assumed.

Throws:

NullPointerException - Thrown if string is null.

StringEntity

public StringEntity(String string,
                    Charset charset)

Constructs a StringEntity with the specified content and charset. The MIME type defaults to "text/plain".

The new instance:

• is not chunked.
• sets the content type to "text/plain" and the given Charset.

Parameters:

string - The content to be used. Not null.

charset - The character set to be used. May be null, in which case the default is StandardCharsets.UTF_8 is assumed.

Throws:

NullPointerException - Thrown if string is null.

Since:

4.2

StringEntity

public StringEntity(String string,
                    Charset charset,
                    boolean chunked)

Constructs a StringEntity with the specified content and content type.

The new instance:

• sets the content type to "text/plain" and the given Charset.

Parameters:

string - The content to be used. Not null.

charset - The character set to be used. May be null, in which case the default is StandardCharsets.UTF_8 is assumed.

chunked - Whether this entity should be chunked.

Throws:

NullPointerException - Thrown if string is null.

StringEntity

public StringEntity(String string)

Constructs a StringEntity with the specified content and content type.

The new instance:

• is not chunked.
• sets the content type to "text/plain" and the given Charset.

Parameters:

string - The content to be used. Not null.

Throws:

NullPointerException - Thrown if string is null.

Method Detail

isRepeatable

public final boolean isRepeatable()

Tests if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.

This implementation always returns false.

This implementation always returns true.

Specified by:

isRepeatable in interface HttpEntity

Overrides:

isRepeatable in class AbstractHttpEntity

Returns:

true if the entity is repeatable, false otherwise.

getContentLength

public final long getContentLength()

Description copied from interface: EntityDetails

Gets length of this entity, if known.

Returns:

the length of this entity, may be 0.

getContent

public final InputStream getContent()
                             throws IOException

Description copied from interface: HttpEntity

Gets 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.

If this entity belongs to an incoming HTTP message, calling InputStream.close() on the returned InputStream will try to consume the complete entity content to keep the connection alive. In cases where this is undesired, e.g. when only a small part of the content is relevant and consuming the complete entity content would be too inefficient, only the HTTP message from which this entity was obtained should be closed (if supported).

IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated after the InputStream.close() method is invoked.

Returns:

content stream of the entity.

Throws:

IOException - if the stream could not be created

See Also:

HttpEntity.isRepeatable()

writeTo

public final void writeTo(OutputStream outStream)
                   throws IOException

Description copied from class: AbstractHttpEntity

Writes this entity to an OutputStream.

Specified by:

writeTo in interface HttpEntity

Overrides:

writeTo in class AbstractHttpEntity

Parameters:

outStream - Where to write the entity, never null.

Throws:

IOException - if the entity cannot generate its content stream; also thrown if the output stream is closed.

isStreaming

public final boolean isStreaming()

Tests 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.

This implementation always returns false.

Returns:

true if the entity content is streamed, false otherwise

close

public final void close()
                 throws IOException

This implementation is a no-op.

Throws:

IOException