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

Class BasicHttpEntity

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, EntityDetails, HttpEntity

@Contract(threading=IMMUTABLE_CONDITIONAL)
public class BasicHttpEntity
extends AbstractHttpEntity

A generic streamed, non-repeatable entity that obtains its content from an InputStream.

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

Since:

4.0

See Also:

ThreadingBehavior.IMMUTABLE_CONDITIONAL

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.InputStream	content
private long	length

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

OUTPUT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
BasicHttpEntity(java.io.InputStream content, long contentLength, ContentType contentType)	Constructs a new instance with the given attributes kept as immutable.
BasicHttpEntity(java.io.InputStream content, long contentLength, ContentType contentType, java.lang.String contentEncoding)	Constructs a new instance with the given attributes kept as immutable.
BasicHttpEntity(java.io.InputStream content, long contentLength, ContentType contentType, java.lang.String contentEncoding, boolean chunked)	Constructs a new instance with the given attributes kept as immutable.
BasicHttpEntity(java.io.InputStream content, ContentType contentType)	Constructs a new instance with the given attributes kept as immutable.
BasicHttpEntity(java.io.InputStream content, ContentType contentType, boolean chunked)	Constructs a new instance with the given attributes kept as immutable.
BasicHttpEntity(java.io.InputStream content, ContentType contentType, java.lang.String contentEncoding)	Constructs a new instance with the given attributes kept as immutable.

Method Summary

Modifier and Type	Method	Description
void	close()
java.io.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.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

content

private final java.io.InputStream content

length

private final long length

Constructor Detail

BasicHttpEntity

public BasicHttpEntity(java.io.InputStream content,
                       long contentLength,
                       ContentType contentType,
                       java.lang.String contentEncoding,
                       boolean chunked)

Constructs a new instance with the given attributes kept as immutable.

Parameters:

content - The message body contents as an InputStream.

contentLength - The value for the Content-Length header for the size of the message body, in bytes.

contentType - The content-type, may be null.

contentEncoding - The content encoding string, may be null.

chunked - Whether this entity should be chunked.

BasicHttpEntity

public BasicHttpEntity(java.io.InputStream content,
                       long contentLength,
                       ContentType contentType,
                       java.lang.String contentEncoding)

Constructs a new instance with the given attributes kept as immutable.

The new instance:

• is not chunked.

Parameters:

content - The message body contents as an InputStream.

contentLength - The value for the Content-Length header for the size of the message body, in bytes.

contentType - The content-type, may be null.

contentEncoding - The content encoding string, may be null.

BasicHttpEntity

public BasicHttpEntity(java.io.InputStream content,
                       long contentLength,
                       ContentType contentType)

Constructs a new instance with the given attributes kept as immutable.

The new instance:

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

Parameters:

content - The message body contents as an InputStream.

contentLength - The value for the Content-Length header for the size of the message body, in bytes.

contentType - The content-type, may be null.

BasicHttpEntity

public BasicHttpEntity(java.io.InputStream content,
                       ContentType contentType,
                       java.lang.String contentEncoding)

Constructs a new instance with the given attributes kept as immutable.

The new instance:

• is not chunked.
• does not define a length.

Parameters:

content - The message body contents as an InputStream.

contentType - The content-type, may be null.

contentEncoding - The content encoding string, may be null.

BasicHttpEntity

public BasicHttpEntity(java.io.InputStream content,
                       ContentType contentType)

Constructs a new instance with the given attributes kept as immutable.

The new instance:

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

Parameters:

content - The message body contents as an InputStream.

contentType - The content-type, may be null.

BasicHttpEntity

public BasicHttpEntity(java.io.InputStream content,
                       ContentType contentType,
                       boolean chunked)

Constructs a new instance with the given attributes kept as immutable.

The new instance:

• does not define a length.
• does not define a content encoding.

Parameters:

content - The message body contents as an InputStream.

contentType - The content-type, may be null.

chunked - Whether this entity should be chunked.

Method Detail

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 java.io.InputStream getContent()
                                     throws java.lang.IllegalStateException

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:

java.lang.IllegalStateException

See Also:

HttpEntity.isRepeatable()

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

Specified by:

isRepeatable in interface HttpEntity

Overrides:

isRepeatable in class AbstractHttpEntity

Returns:

true if the entity is repeatable, false otherwise.

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

Returns:

true if the entity content is streamed, false otherwise

close

public final void close()
                 throws java.io.IOException

Throws:

java.io.IOException