Class AbstractHttpEntity
java.lang.Object
org.apache.hc.core5.http.io.entity.AbstractHttpEntity
- All Implemented Interfaces:
Closeable
,AutoCloseable
,EntityDetails
,HttpEntity
- Direct Known Subclasses:
BasicHttpEntity
,ByteArrayEntity
,ByteBufferEntity
,EntityTemplate
,FileEntity
,InputStreamEntity
,PathEntity
,SerializableEntity
,StringEntity
Abstract base class for mutable entities. Provides the commonly used attributes for streamed and
self-contained implementations.
- Since:
- 4.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractHttpEntity
(String contentType, String contentEncoding) protected
AbstractHttpEntity
(String contentType, String contentEncoding, boolean chunked) protected
AbstractHttpEntity
(ContentType contentType, String contentEncoding) protected
AbstractHttpEntity
(ContentType contentType, String contentEncoding, boolean chunked) -
Method Summary
Modifier and TypeMethodDescriptionfinal String
Returns content encoding of the entity, if known.final String
Returns content type of the entity, if known.Preliminary declaration of trailing headers.Returns supplier of message trailers - headers sent after message body.final boolean
Returns chunked transfer hint for this entity.boolean
Tells if the entity is capable of producing its data more than once.toString()
void
writeTo
(OutputStream outStream) Writes the entity content out to the output stream.static void
writeTo
(HttpEntity entity, OutputStream outStream) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.hc.core5.http.EntityDetails
getContentLength
Methods inherited from interface org.apache.hc.core5.http.HttpEntity
getContent, isStreaming
-
Field Details
-
OUTPUT_BUFFER_SIZE
static final int OUTPUT_BUFFER_SIZE- See Also:
-
contentType
-
contentEncoding
-
chunked
private final boolean chunked
-
-
Constructor Details
-
AbstractHttpEntity
-
AbstractHttpEntity
-
AbstractHttpEntity
-
AbstractHttpEntity
-
-
Method Details
-
writeTo
- Throws:
IOException
-
writeTo
Description copied from interface:HttpEntity
Writes the entity content out to the output stream.IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
- Specified by:
writeTo
in interfaceHttpEntity
- Parameters:
outStream
- the output stream to write entity content to- Throws:
IOException
- if an I/O error occurs
-
getContentType
Description copied from interface:EntityDetails
Returns content type of the entity, if known.- Specified by:
getContentType
in interfaceEntityDetails
-
getContentEncoding
Description copied from interface:EntityDetails
Returns content encoding of the entity, if known.- Specified by:
getContentEncoding
in interfaceEntityDetails
-
isChunked
public final boolean isChunked()Description copied from interface:EntityDetails
Returns chunked transfer hint for this entity.The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
- Specified by:
isChunked
in interfaceEntityDetails
-
isRepeatable
public boolean isRepeatable()Description copied from interface:HttpEntity
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.- Specified by:
isRepeatable
in interfaceHttpEntity
- Returns:
- true if the entity is repeatable, false otherwise.
-
getTrailers
Description copied from interface:HttpEntity
Returns supplier of message trailers - headers sent after message body. May returnnull
if trailers are not available.- Specified by:
getTrailers
in interfaceHttpEntity
-
getTrailerNames
Description copied from interface:EntityDetails
Preliminary declaration of trailing headers.- Specified by:
getTrailerNames
in interfaceEntityDetails
-
toString
-