public class NFileEntity extends AbstractHttpEntity implements HttpAsyncContentProducer, ProducingNHttpEntity
chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE| Constructor and Description |
|---|
NFileEntity(File file) |
NFileEntity(File file,
ContentType contentType)
Creates new instance of NFileEntity from the given source
File
with the given content type. |
NFileEntity(File file,
ContentType contentType,
boolean useFileChannels)
Creates new instance of NFileEntity from the given source
File
with the given content type. |
NFileEntity(File file,
String contentType)
Deprecated.
(4.2) use
NFileEntity(File, ContentType) |
NFileEntity(File file,
String contentType,
boolean useFileChannels)
Deprecated.
(4.2) use
NFileEntity(File, ContentType, boolean) |
| Modifier and Type | Method and Description |
|---|---|
void |
close() |
void |
finish()
Deprecated.
(4.2) use
close() |
InputStream |
getContent()
Returns a content stream of the entity.
|
long |
getContentLength()
Tells the length of the content, if known.
|
boolean |
isRepeatable()
Determines whether or not this producer is capable of producing
its content more than once.
|
boolean |
isStreaming()
Tells whether this entity depends on an underlying stream.
|
void |
produceContent(ContentEncoder encoder,
IOControl ioControl)
Invoked to write out a chunk of content to the
ContentEncoder. |
void |
writeTo(OutputStream outStream)
Writes the entity content out to the output stream.
|
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitconsumeContent, getContentEncoding, getContentType, isChunkedpublic NFileEntity(File file, ContentType contentType, boolean useFileChannels)
File
with the given content type. If useFileChannels is set to
true, the entity will try to use FileContentEncoder
interface to stream file content directly from the file channel.file - the source file.contentType - the content type of the file.useFileChannels - flag whether the direct transfer from the file
channel should be attempted.public NFileEntity(File file)
public NFileEntity(File file, ContentType contentType)
File
with the given content type.file - the source file.contentType - the content type of the file.@Deprecated public NFileEntity(File file, String contentType, boolean useFileChannels)
NFileEntity(File, ContentType, boolean)@Deprecated public NFileEntity(File file, String contentType)
NFileEntity(File, ContentType)public void close()
throws IOException
close in interface Closeableclose in interface AutoCloseableIOException@Deprecated public void finish() throws IOException
close()finish in interface ProducingNHttpEntityIOExceptionpublic long getContentLength()
HttpEntitygetContentLength in interface HttpEntityLong.MAX_VALUE,
a negative number is returned.public boolean isRepeatable()
HttpAsyncContentProducerisRepeatable in interface HttpEntityisRepeatable in interface HttpAsyncContentProducerpublic void produceContent(ContentEncoder encoder, IOControl ioControl) throws IOException
HttpAsyncContentProducerContentEncoder.
The IOControl 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.
The IOControl object can be shared and used on other thread
to resume output event notifications when more content is made available.
produceContent in interface HttpAsyncContentProducerproduceContent in interface ProducingNHttpEntityencoder - content encoder.ioControl - I/O control of the underlying connection.IOExceptionpublic boolean isStreaming()
HttpEntitytrue. Self-contained entities should return
false. Wrapping entities should delegate this call
to the wrapped entity.isStreaming in interface HttpEntitytrue if the entity content is streamed,
false otherwisepublic InputStream getContent() throws IOException
HttpEntityRepeatable 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: Please note all entity implementations must ensure that
all allocated resources are properly deallocated after
the InputStream.close() method is invoked.
getContent in interface HttpEntityIOException - if the stream could not be createdHttpEntity.isRepeatable()public void writeTo(OutputStream outStream) throws IOException
HttpEntityIMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo in interface HttpEntityoutStream - the output stream to write entity content toIOException - if an I/O error occursCopyright © 2005–2022 The Apache Software Foundation. All rights reserved.