Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.io.entity.BufferedHttpEntity

public Class BufferedHttpEntity

A wrapping entity that buffers it content if necessary. The buffered entity is always repeatable. If the wrapped entity is repeatable itself, calls are passed through. If the wrapped entity is not repeatable, the content is read into a buffer once and provided from there as often as required.

Since

4.0

Field Summary

Modifier and Type	Field and Description
private final byte[]	buffer

Constructor Summary

Access	Constructor and Description
public	BufferedHttpEntity(final HttpEntity the entity to wrap, not null entity) Creates a new buffered entity wrapper.

Modifier and Type	Method and Description
public InputStream	getContent() Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.getContent. Implements org.apache.hc.core5.http.HttpEntity.getContent. Returns a content stream of the entity.
public long	getContentLength() Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.getContentLength. Implements org.apache.hc.core5.http.EntityDetails.getContentLength. Returns length of the entity, if known.
public boolean	Returns: `false` isChunked() Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isChunked. Implements org.apache.hc.core5.http.EntityDetails.isChunked. Tells that this entity does not have to be chunked.
public boolean	Returns: `true` isRepeatable() Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isRepeatable. Implements org.apache.hc.core5.http.HttpEntity.isRepeatable. Tells that this entity is repeatable.
public boolean	isStreaming() Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isStreaming. Implements org.apache.hc.core5.http.HttpEntity.isStreaming. Tells whether this entity depends on an underlying stream.
public void	writeTo(final OutputStream the output stream to write entity content to outStream) Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.writeTo. Implements org.apache.hc.core5.http.HttpEntity.writeTo. Writes the entity content out to the output stream.

Modifier and Type

Method and Description

public InputStream

getContent()

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.getContent.

Implements org.apache.hc.core5.http.HttpEntity.getContent.

Returns a content stream of the entity.

public long

getContentLength()

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.getContentLength.

Implements org.apache.hc.core5.http.EntityDetails.getContentLength.

Returns length of the entity, if known.

public boolean

Returns:

false

isChunked()

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isChunked.

Implements org.apache.hc.core5.http.EntityDetails.isChunked.

Tells that this entity does not have to be chunked.

public boolean

Returns:

true

isRepeatable()

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isRepeatable.

Implements org.apache.hc.core5.http.HttpEntity.isRepeatable.

Tells that this entity is repeatable.

public boolean

isStreaming()

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isStreaming.

Implements org.apache.hc.core5.http.HttpEntity.isStreaming.

Tells whether this entity depends on an underlying stream.

public void

writeTo(final OutputStream

the output stream to write entity content to

outStream)

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.writeTo.

Implements org.apache.hc.core5.http.HttpEntity.writeTo.

Writes the entity content out to the output stream.

Field Detail

buffer	back to summary
private final byte[] buffer

Constructor Detail

BufferedHttpEntity	back to summary
public BufferedHttpEntity(final HttpEntity entity) throws IOException Creates a new buffered entity wrapper. Parameters entity:HttpEntity the entity to wrap, not null Exceptions IllegalArgumentException: if wrapped is null

BufferedHttpEntity

back to summary

public BufferedHttpEntity(final HttpEntity entity) throws IOException

Creates a new buffered entity wrapper.

Parameters

entity:HttpEntity: the entity to wrap, not null

Exceptions

IllegalArgumentException:: if wrapped is null

Method Detail

getContent back to summary

getContent	back to summary
public InputStream getContent() throws IOException Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.getContent. Implements org.apache.hc.core5.http.HttpEntity.getContent. Doc from org.apache.hc.core5.http.HttpEntity.getContent. 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. 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 Note Please note all entity implementations must ensure that all allocated resources are properly deallocated after the `InputStream#close()` method is invoked. Returns:InputStream content stream of the entity. Annotations @Override Exceptions IOException: if the stream could not be created

public InputStream getContent() throws IOException

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.getContent.

Implements org.apache.hc.core5.http.HttpEntity.getContent.

Doc from org.apache.hc.core5.http.HttpEntity.getContent.

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.

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 Note

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

Returns:InputStream

content stream of the entity.

Annotations

@Override

Exceptions

IOException:: if the stream could not be created

getContentLength	back to summary
public long getContentLength() Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.getContentLength. Implements org.apache.hc.core5.http.EntityDetails.getContentLength. Doc from org.apache.hc.core5.http.EntityDetails.getContentLength. Returns length of the entity, if known. Annotations @Override

getContentLength

back to summary

public long getContentLength()

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.getContentLength.

Implements org.apache.hc.core5.http.EntityDetails.getContentLength.

Doc from org.apache.hc.core5.http.EntityDetails.getContentLength.

Returns length of the entity, if known.

Annotations

@Override

isChunked back to summary

isChunked	back to summary
public boolean isChunked() Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isChunked. Implements org.apache.hc.core5.http.EntityDetails.isChunked. Tells that this entity does not have to be chunked. Returns:boolean `false` Annotations @Override

public boolean isChunked()

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isChunked.

Implements org.apache.hc.core5.http.EntityDetails.isChunked.

Tells that this entity does not have to be chunked.

Returns:boolean

false

Annotations

@Override

isRepeatable back to summary

isRepeatable	back to summary
public boolean isRepeatable() Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isRepeatable. Implements org.apache.hc.core5.http.HttpEntity.isRepeatable. Tells that this entity is repeatable. Returns:boolean `true` Annotations @Override

public boolean isRepeatable()

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isRepeatable.

Implements org.apache.hc.core5.http.HttpEntity.isRepeatable.

Tells that this entity is repeatable.

Returns:boolean

true

Annotations

@Override

isStreaming back to summary

isStreaming	back to summary
public boolean isStreaming() Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isStreaming. Implements org.apache.hc.core5.http.HttpEntity.isStreaming. Doc from org.apache.hc.core5.http.HttpEntity.isStreaming. 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. Returns:boolean `true` if the entity content is streamed, `false` otherwise Annotations @Override

public boolean isStreaming()

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.isStreaming.

Implements org.apache.hc.core5.http.HttpEntity.isStreaming.

Doc from org.apache.hc.core5.http.HttpEntity.isStreaming.

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.

Returns:boolean

true if the entity content is streamed, false otherwise

Annotations

@Override

writeTo	back to summary
public void writeTo(final OutputStream outStream) throws IOException Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.writeTo. Implements org.apache.hc.core5.http.HttpEntity.writeTo. Doc from org.apache.hc.core5.http.HttpEntity.writeTo. Writes the entity content out to the output stream. Important Note Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns. Parameters outStream:OutputStream the output stream to write entity content to Annotations @Override Exceptions IOException: if an I/O error occurs

writeTo

back to summary

public void writeTo(final OutputStream outStream) throws IOException

Overrides org.apache.hc.core5.http.io.entity.HttpEntityWrapper.writeTo.

Implements org.apache.hc.core5.http.HttpEntity.writeTo.

Doc from org.apache.hc.core5.http.HttpEntity.writeTo.

Writes the entity content out to the output stream.

Important Note

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

Parameters

outStream:OutputStream: the output stream to write entity content to

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

public Class BufferedHttpEntity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail