Class FileEntity
java.lang.Object
org.apache.hc.core5.http.io.entity.AbstractHttpEntity
org.apache.hc.core5.http.io.entity.FileEntity
- All Implemented Interfaces:
Closeable
,AutoCloseable
,EntityDetails
,HttpEntity
A self contained, repeatable entity that obtains its content from a file.
- Since:
- 4.0
-
Field Summary
FieldsFields inherited from class org.apache.hc.core5.http.io.entity.AbstractHttpEntity
OUTPUT_BUFFER_SIZE
-
Constructor Summary
ConstructorsConstructorDescriptionFileEntity
(File file, ContentType contentType) FileEntity
(File file, ContentType contentType, String contentEncoding) -
Method Summary
Modifier and TypeMethodDescriptionfinal void
close()
final InputStream
Returns a content stream of the entity.final long
Returns length of the entity, if known.final boolean
Tells if the entity is capable of producing its data more than once.final boolean
Tells whether this entity depends on an underlying stream.Methods inherited from class org.apache.hc.core5.http.io.entity.AbstractHttpEntity
getContentEncoding, getContentType, getTrailerNames, getTrailers, isChunked, toString, writeTo, writeTo
-
Field Details
-
file
-
-
Constructor Details
-
FileEntity
-
FileEntity
-
-
Method Details
-
isRepeatable
public final 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
- Overrides:
isRepeatable
in classAbstractHttpEntity
- Returns:
- true if the entity is repeatable, false otherwise.
-
getContentLength
public final long getContentLength()Description copied from interface:EntityDetails
Returns length of the entity, if known. -
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.- Returns:
- content stream of the entity.
- Throws:
IOException
- if the stream could not be created- See Also:
-
isStreaming
public final 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.- Returns:
true
if the entity content is streamed,false
otherwise
-
close
- Throws:
IOException
-