Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.impl.io.IncomingHttpEntity

Modifier and Type	Field and Description
private final boolean	chunked
private final InputStream	content
private final Header	contentEncoding
private final Header	contentType
private final long	len

Access	Constructor and Description
pack-priv	IncomingHttpEntity(final InputStream content, final long len, final boolean chunked, final Header contentType, final Header contentEncoding)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public InputStream	getContent() Implements org.apache.hc.core5.http.HttpEntity.getContent. Returns a content stream of the entity.
public String	getContentEncoding() Implements org.apache.hc.core5.http.EntityDetails.getContentEncoding. Returns content encoding of the entity, if known.
public long	getContentLength() Implements org.apache.hc.core5.http.EntityDetails.getContentLength. Returns length of the entity, if known.
public String	getContentType() Implements org.apache.hc.core5.http.EntityDetails.getContentType. Returns content type of the entity, if known.
public Set<String>	getTrailerNames() Implements org.apache.hc.core5.http.EntityDetails.getTrailerNames. Preliminary declaration of trailing headers.
public Supplier<List<? extends Header>>	getTrailers() Implements org.apache.hc.core5.http.HttpEntity.getTrailers. Returns supplier of message trailers - headers sent after message body.
public boolean	isChunked() Implements org.apache.hc.core5.http.EntityDetails.isChunked. Returns chunked transfer hint for this entity.
public boolean	isRepeatable() Implements org.apache.hc.core5.http.HttpEntity.isRepeatable. Tells if the entity is capable of producing its data more than once.
public boolean	isStreaming() Implements org.apache.hc.core5.http.HttpEntity.isStreaming. Tells whether this entity depends on an underlying stream.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writeTo(final OutputStream the output stream to write entity content to outStream) Implements org.apache.hc.core5.http.HttpEntity.writeTo. Writes the entity content out to the output stream.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

chunked	back to summary
private final boolean chunked

content	back to summary
private final InputStream content

contentEncoding	back to summary
private final Header contentEncoding

contentType	back to summary
private final Header contentType

len	back to summary
private final long len

IncomingHttpEntity	back to summary
pack-priv IncomingHttpEntity(final InputStream content, final long len, final boolean chunked, final Header contentType, final Header contentEncoding)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

getContent back to summary

getContent	back to summary
public InputStream getContent() throws IOException, IllegalStateException 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, IllegalStateException

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

getContentEncoding	back to summary
public String getContentEncoding() Implements org.apache.hc.core5.http.EntityDetails.getContentEncoding. Doc from org.apache.hc.core5.http.EntityDetails.getContentEncoding. Returns content encoding of the entity, if known. Annotations @Override

getContentEncoding

back to summary

public String getContentEncoding()

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

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

Returns content encoding of the entity, if known.

Annotations

@Override

getContentLength	back to summary
public long 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()

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

getContentType	back to summary
public String getContentType() Implements org.apache.hc.core5.http.EntityDetails.getContentType. Doc from org.apache.hc.core5.http.EntityDetails.getContentType. Returns content type of the entity, if known. Annotations @Override

getContentType

back to summary

public String getContentType()

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

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

Returns content type of the entity, if known.

Annotations

@Override

getTrailerNames	back to summary
public Set<String> getTrailerNames() Implements org.apache.hc.core5.http.EntityDetails.getTrailerNames. Doc from org.apache.hc.core5.http.EntityDetails.getTrailerNames. Preliminary declaration of trailing headers. Annotations @Override

getTrailerNames

back to summary

public Set<String> getTrailerNames()

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

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

Preliminary declaration of trailing headers.

Annotations

@Override

getTrailers back to summary

getTrailers	back to summary
public Supplier<List<? extends Header>> getTrailers() Implements org.apache.hc.core5.http.HttpEntity.getTrailers. Doc from org.apache.hc.core5.http.HttpEntity.getTrailers. Returns supplier of message trailers - headers sent after message body. May return `null` if trailers are not available. Annotations @Override

public Supplier<List<? extends Header>> getTrailers()

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

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

Returns supplier of message trailers - headers sent after message body. May return null if trailers are not available.

Annotations

@Override

isChunked	back to summary
public boolean isChunked() Implements org.apache.hc.core5.http.EntityDetails.isChunked. Doc from org.apache.hc.core5.http.EntityDetails.isChunked. Returns chunked transfer hint for this entity. The behavior of wrapping entities is implementation dependent, but should respect the primary purpose. Annotations @Override

isChunked

back to summary

public boolean isChunked()

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

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

Returns chunked transfer hint for this entity.

The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

Annotations

@Override

isRepeatable	back to summary
public boolean isRepeatable() Implements org.apache.hc.core5.http.HttpEntity.isRepeatable. Doc from org.apache.hc.core5.http.HttpEntity.isRepeatable. Tells 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. Returns:boolean true if the entity is repeatable, false otherwise. Annotations @Override

isRepeatable

back to summary

public boolean isRepeatable()

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

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

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

Returns:boolean

true if the entity is repeatable, false otherwise.

Annotations

@Override

isStreaming back to summary

isStreaming	back to summary
public boolean 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()

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

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

writeTo	back to summary
public void writeTo(final OutputStream outStream) throws IOException 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

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

pack-priv Class IncomingHttpEntity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail