Package io.vertx.core.http
Interface HttpServerFileUpload
-
- All Superinterfaces:
ReadStream<Buffer>,StreamBase
public interface HttpServerFileUpload extends ReadStream<Buffer>
Represents an file upload from an HTML FORM.- Author:
- Norman Maurer
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancancelStreamToFileSystem()Try to cancel the file system streaming, the streamed file will be deleted.Stringcharset()StringcontentTransferEncoding()StringcontentType()HttpServerFileUploadendHandler(Handler<Void> endHandler)Set an end handler.HttpServerFileUploadexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.HttpServerFileUploadfetch(long amount)Fetch the specifiedamountof elements.AsyncFilefile()Stringfilename()HttpServerFileUploadhandler(Handler<Buffer> handler)Set a data handler.booleanisSizeAvailable()Stringname()HttpServerFileUploadpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.HttpServerFileUploadresume()Resume reading, and sets the buffer inflowingmode.longsize()The size of the upload may not be available until it is all read.Future<Void>streamToFileSystem(String filename)Stream the content of this upload to the given file on storage.-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
-
-
-
Method Detail
-
exceptionHandler
HttpServerFileUpload exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<Buffer>- Specified by:
exceptionHandlerin interfaceStreamBase- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
HttpServerFileUpload handler(Handler<Buffer> handler)
Description copied from interface:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
HttpServerFileUpload endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
pause
HttpServerFileUpload pause()
Description copied from interface:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
resume
HttpServerFileUpload resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
fetch
HttpServerFileUpload fetch(long amount)
Description copied from interface:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
streamToFileSystem
Future<Void> streamToFileSystem(String filename)
Stream the content of this upload to the given file on storage.If the stream has a failure or is cancelled the created file will be deleted.
- Parameters:
filename- the name of the file
-
cancelStreamToFileSystem
boolean cancelStreamToFileSystem() throws IllegalStateExceptionTry to cancel the file system streaming, the streamed file will be deleted.- Returns:
truewhen the stream is cancelled, otherwise it means that stream is finished- Throws:
IllegalStateException- when no stream is in progress
-
filename
String filename()
- Returns:
- the filename which was used when upload the file.
-
name
String name()
- Returns:
- the name of the attribute
-
contentType
String contentType()
- Returns:
- the content type for the upload
-
contentTransferEncoding
String contentTransferEncoding()
- Returns:
- the contentTransferEncoding for the upload
-
charset
String charset()
- Returns:
- the charset for the upload
-
size
long size()
The size of the upload may not be available until it is all read. CheckisSizeAvailable()to determine this- Returns:
- the size of the upload (in bytes)
-
isSizeAvailable
boolean isSizeAvailable()
- Returns:
trueif the size of the upload can be retrieved viasize().
-
file
AsyncFile file()
- Returns:
- the async uploaded file when
streamToFileSystem(java.lang.String)has been used and the file is available
-
-