Class IncomingHttpEntity
- All Implemented Interfaces:
Closeable
,AutoCloseable
,EntityDetails
,HttpEntity
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
private final InputStream
private final Header
private final Header
private final long
-
Constructor Summary
ConstructorsConstructorDescriptionIncomingHttpEntity
(InputStream content, long len, boolean chunked, Header contentType, Header contentEncoding) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Returns a content stream of the entity.Returns content encoding of the entity, if known.long
Returns length of the entity, if known.Returns content type of the entity, if known.Preliminary declaration of trailing headers.Returns supplier of message trailers - headers sent after message body.boolean
Returns chunked transfer hint for this entity.boolean
Tells if the entity is capable of producing its data more than once.boolean
Tells whether this entity depends on an underlying stream.toString()
void
writeTo
(OutputStream outStream) Writes the entity content out to the output stream.
-
Field Details
-
-
len
private final long len -
chunked
private final boolean chunked -
contentType
-
contentEncoding
-
-
Constructor Details
-
IncomingHttpEntity
IncomingHttpEntity(InputStream content, long len, boolean chunked, Header contentType, Header contentEncoding)
-
-
Method Details
-
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.
-
isChunked
public 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
-
getContentLength
public long getContentLength()Description copied from interface:EntityDetails
Returns length of the entity, if known.- Specified by:
getContentLength
in interfaceEntityDetails
-
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
-
getContent
Description copied from interface:HttpEntity
Returns a content stream of the entity.Repeatable
entities are expected to create a new instance ofInputStream
for each invocation of this method and therefore can be consumed multiple times. Entities that are notrepeatable
are expected to return the sameInputStream
instance and therefore may not be consumed more than once.If this entity belongs to an incoming HTTP message, calling
InputStream.close()
on the returnedInputStream
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.- Specified by:
getContent
in interfaceHttpEntity
- Returns:
- content stream of the entity.
- Throws:
IOException
- if the stream could not be createdIllegalStateException
- See Also:
-
isStreaming
public boolean isStreaming()Description copied from interface:HttpEntity
Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should returntrue
. Self-contained entities should returnfalse
. Wrapping entities should delegate this call to the wrapped entity.- Specified by:
isStreaming
in interfaceHttpEntity
- Returns:
true
if the entity content is streamed,false
otherwise
-
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
-
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
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
toString
-