Apache HttpClient 4.5.14 · org.apache.http.impl.execchain.RequestEntityProxy

Modifier and Type	Field and Description
private boolean	consumed
private final HttpEntity	original

Access	Constructor and Description
pack-priv	RequestEntityProxy(final HttpEntity original)

Method Summary

Modifier and Type	Method and Description
public void	consumeContent() Implements org.apache.http.HttpEntity.consumeContent. This method is deprecated since version 4.1.
pack-priv static void	enhance(final HttpEntityEnclosingRequest request)
public InputStream	getContent() Implements org.apache.http.HttpEntity.getContent. Returns a content stream of the entity.
public Header	getContentEncoding() Implements org.apache.http.HttpEntity.getContentEncoding. Obtains the Content-Encoding header, if known.
public long	getContentLength() Implements org.apache.http.HttpEntity.getContentLength. Tells the length of the content, if known.
public Header	getContentType() Implements org.apache.http.HttpEntity.getContentType. Obtains the Content-Type header, if known.
public HttpEntity	getOriginal()
public boolean	isChunked() Implements org.apache.http.HttpEntity.isChunked. Tells about chunked encoding for this entity.
public boolean	isConsumed()
pack-priv static boolean	isEnhanced(final HttpEntity entity)
pack-priv static boolean	isRepeatable(final HttpRequest request)
public boolean	isRepeatable() Implements org.apache.http.HttpEntity.isRepeatable. Tells if the entity is capable of producing its data more than once.
public boolean	isStreaming() Implements org.apache.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.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

consumed	back to summary
private boolean consumed

original	back to summary
private final HttpEntity original

RequestEntityProxy	back to summary
pack-priv RequestEntityProxy(final HttpEntity original)

Method Detail

consumeContent back to summary

consumeContent	back to summary
public void consumeContent() throws IOException Implements org.apache.http.HttpEntity.consumeContent. Doc from org.apache.http.HttpEntity.consumeContent. This method is deprecated since version 4.1. Please use standard java convention to ensure resource deallocation by calling `InputStream#close()` on the input stream returned by `getContent()` This method is called to indicate that the content of this entity is no longer required. All entity implementations are expected to release all allocated resources as a result of this method invocation. Content streaming entities are also expected to dispose of the remaining content, if any. Wrapping entities should delegate this call to the wrapped entity. This method is of particular importance for entities being received from a `connection`. The entity needs to be consumed completely in order to re-use the connection with keep-alive. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void consumeContent() throws IOException

Implements org.apache.http.HttpEntity.consumeContent.

Doc from org.apache.http.HttpEntity.consumeContent.

This method is deprecated since version 4.1. Please use standard java convention to ensure resource deallocation by calling InputStream#close() on the input stream returned by getContent()

This method is called to indicate that the content of this entity is no longer required. All entity implementations are expected to release all allocated resources as a result of this method invocation. Content streaming entities are also expected to dispose of the remaining content, if any. Wrapping entities should delegate this call to the wrapped entity.

This method is of particular importance for entities being received from a connection. The entity needs to be consumed completely in order to re-use the connection with keep-alive.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

enhance	back to summary
pack-priv static void enhance(final HttpEntityEnclosingRequest request)

getContent back to summary

getContent	back to summary
public InputStream getContent() throws IOException, IllegalStateException Implements org.apache.http.HttpEntity.getContent. Doc from org.apache.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. 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.http.HttpEntity.getContent.

Doc from org.apache.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.

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

getContentEncoding	back to summary
public Header getContentEncoding() Implements org.apache.http.HttpEntity.getContentEncoding. Doc from org.apache.http.HttpEntity.getContentEncoding. Obtains the Content-Encoding header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. Wrapping entities that modify the content encoding should adjust this header accordingly. Returns:Header the Content-Encoding header for this entity, or `null` if the content encoding is unknown Annotations @Override

public Header getContentEncoding()

Implements org.apache.http.HttpEntity.getContentEncoding.

Doc from org.apache.http.HttpEntity.getContentEncoding.

Obtains the Content-Encoding header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. Wrapping entities that modify the content encoding should adjust this header accordingly.

Returns:Header

the Content-Encoding header for this entity, or null if the content encoding is unknown

Annotations

@Override

getContentLength back to summary

getContentLength	back to summary
public long getContentLength() Implements org.apache.http.HttpEntity.getContentLength. Doc from org.apache.http.HttpEntity.getContentLength. Tells the length of the content, if known. Returns:long 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. Annotations @Override

public long getContentLength()

Implements org.apache.http.HttpEntity.getContentLength.

Doc from org.apache.http.HttpEntity.getContentLength.

Tells the length of the content, if known.

Returns:long

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.

Annotations

@Override

getContentType back to summary

getContentType	back to summary
public Header getContentType() Implements org.apache.http.HttpEntity.getContentType. Doc from org.apache.http.HttpEntity.getContentType. Obtains the Content-Type header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. It can include a charset attribute. Returns:Header the Content-Type header for this entity, or `null` if the content type is unknown Annotations @Override

public Header getContentType()

Implements org.apache.http.HttpEntity.getContentType.

Doc from org.apache.http.HttpEntity.getContentType.

Obtains the Content-Type header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. It can include a charset attribute.

Returns:Header

the Content-Type header for this entity, or null if the content type is unknown

Annotations

@Override

getOriginal	back to summary
public HttpEntity getOriginal()

isChunked back to summary

isChunked	back to summary
public boolean isChunked() Implements org.apache.http.HttpEntity.isChunked. Doc from org.apache.http.HttpEntity.isChunked. Tells about chunked encoding for this entity. The primary purpose of this method is to indicate whether chunked encoding should be used when the entity is sent. For entities that are received, it can also indicate whether the entity was received with chunked encoding. The behavior of wrapping entities is implementation dependent, but should respect the primary purpose. Returns:boolean `true` if chunked encoding is preferred for this entity, or `false` if it is not Annotations @Override

public boolean isChunked()

Implements org.apache.http.HttpEntity.isChunked.

Doc from org.apache.http.HttpEntity.isChunked.

Tells about chunked encoding for this entity. The primary purpose of this method is to indicate whether chunked encoding should be used when the entity is sent. For entities that are received, it can also indicate whether the entity was received with chunked encoding.

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

Returns:boolean

true if chunked encoding is preferred for this entity, or false if it is not

Annotations

@Override

isConsumed	back to summary
public boolean isConsumed()

isEnhanced	back to summary
pack-priv static boolean isEnhanced(final HttpEntity entity)

isRepeatable	back to summary
pack-priv static boolean isRepeatable(final HttpRequest request)

isRepeatable	back to summary
public boolean isRepeatable() Implements org.apache.http.HttpEntity.isRepeatable. Doc from org.apache.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.http.HttpEntity.isRepeatable.

Doc from org.apache.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.http.HttpEntity.isStreaming. Doc from org.apache.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.http.HttpEntity.isStreaming.

Doc from org.apache.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.http.HttpEntity.writeTo. Doc from org.apache.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.http.HttpEntity.writeTo.

Doc from org.apache.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 RequestEntityProxy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail