Package org.apache.http.nio.entity
Class NFileEntity
java.lang.Object
org.apache.http.entity.AbstractHttpEntity
org.apache.http.nio.entity.NFileEntity
- All Implemented Interfaces:
Closeable
,AutoCloseable
,org.apache.http.HttpEntity
,HttpAsyncContentProducer
,ProducingNHttpEntity
public class NFileEntity
extends org.apache.http.entity.AbstractHttpEntity
implements HttpAsyncContentProducer, ProducingNHttpEntity
A self contained, repeatable non-blocking entity that retrieves its content
from a file. This class is mostly used to stream large files of different
types, so one needs to supply the content type of the file to make sure
the content can be correctly recognized and processed by the recipient.
- Since:
- 4.0
-
Field Summary
Fields inherited from class org.apache.http.entity.AbstractHttpEntity
chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE
-
Constructor Summary
ConstructorsConstructorDescriptionNFileEntity
(File file) NFileEntity
(File file, String contentType) Deprecated.NFileEntity
(File file, String contentType, boolean useFileChannels) Deprecated.(4.2) useNFileEntity(File, ContentType, boolean)
NFileEntity
(File file, org.apache.http.entity.ContentType contentType) Creates new instance of NFileEntity from the given sourceFile
with the given content type.NFileEntity
(File file, org.apache.http.entity.ContentType contentType, boolean useFileChannels) Creates new instance of NFileEntity from the given sourceFile
with the given content type. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
void
finish()
Deprecated.(4.2) useclose()
long
boolean
Determines whether or not this producer is capable of producing its content more than once.boolean
void
produceContent
(ContentEncoder encoder, IOControl ioControl) Invoked to write out a chunk of content to theContentEncoder
.void
writeTo
(OutputStream outStream) Methods inherited from class org.apache.http.entity.AbstractHttpEntity
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.http.HttpEntity
consumeContent, getContentEncoding, getContentType, isChunked
-
Constructor Details
-
NFileEntity
public NFileEntity(File file, org.apache.http.entity.ContentType contentType, boolean useFileChannels) Creates new instance of NFileEntity from the given sourceFile
with the given content type. IfuseFileChannels
is set totrue
, the entity will try to useFileContentEncoder
interface to stream file content directly from the file channel.- Parameters:
file
- the source file.contentType
- the content type of the file.useFileChannels
- flag whether the direct transfer from the file channel should be attempted.- Since:
- 4.2
-
NFileEntity
- Since:
- 4.2
-
NFileEntity
Creates new instance of NFileEntity from the given sourceFile
with the given content type.- Parameters:
file
- the source file.contentType
- the content type of the file.- Since:
- 4.2
-
NFileEntity
Deprecated.(4.2) useNFileEntity(File, ContentType, boolean)
-
NFileEntity
Deprecated.(4.2) useNFileEntity(File, ContentType)
-
-
Method Details
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
- Since:
- 4.2
-
finish
Deprecated.(4.2) useclose()
Notification that any resources allocated for writing can be released.- Specified by:
finish
in interfaceProducingNHttpEntity
- Throws:
IOException
-
getContentLength
public long getContentLength()- Specified by:
getContentLength
in interfaceorg.apache.http.HttpEntity
-
isRepeatable
public boolean isRepeatable()Description copied from interface:HttpAsyncContentProducer
Determines whether or not this producer is capable of producing its content more than once. Repeatable content producers are expected to be able to recreate their content even after having been closed.- Specified by:
isRepeatable
in interfaceHttpAsyncContentProducer
- Specified by:
isRepeatable
in interfaceorg.apache.http.HttpEntity
-
produceContent
Description copied from interface:HttpAsyncContentProducer
Invoked to write out a chunk of content to theContentEncoder
. TheIOControl
interface can be used to suspend output event notifications if the entity is temporarily unable to produce more content.When all content is finished, the producer MUST call
ContentEncoder.complete()
. Failure to do so may cause the entity to be incorrectly delimited.Please note that the
ContentEncoder
object is not thread-safe and should only be used within the context of this method call. TheIOControl
object can be shared and used on other thread to resume output event notifications when more content is made available.- Specified by:
produceContent
in interfaceHttpAsyncContentProducer
- Specified by:
produceContent
in interfaceProducingNHttpEntity
- Parameters:
encoder
- content encoder.ioControl
- I/O control of the underlying connection.- Throws:
IOException
-
isStreaming
public boolean isStreaming()- Specified by:
isStreaming
in interfaceorg.apache.http.HttpEntity
-
getContent
- Specified by:
getContent
in interfaceorg.apache.http.HttpEntity
- Throws:
IOException
-
writeTo
- Specified by:
writeTo
in interfaceorg.apache.http.HttpEntity
- Throws:
IOException
-
NFileEntity(File, ContentType)