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

Modifier and Type	Method and Description
String	charset()
String	contentTransferEncoding()
String	contentType()
HttpServerFileUpload	endHandler(Handler<Void> endHandler) Set an end handler.
HttpServerFileUpload	exceptionHandler(Handler<Throwable> handler) Set an exception handler on the read stream.
String	filename()
HttpServerFileUpload	handler(Handler<Buffer> handler) Set a data handler.
boolean	isSizeAvailable()
String	name()
HttpServerFileUpload	pause() Pause the ReadSupport.
HttpServerFileUpload	resume() Resume reading.
long	size() The size of the upload may not be available until it is all read.
HttpServerFileUpload	streamToFileSystem(String filename) Stream the content of this upload to the given file on storage.

Method Detail

exceptionHandler

HttpServerFileUpload exceptionHandler(Handler<Throwable> handler)

Description copied from interface: ReadStream

Set an exception handler on the read stream.

Specified by:

exceptionHandler in interface ReadStream<Buffer>

Specified by:

exceptionHandler in interface StreamBase

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: ReadStream

Set a data handler. As data is read, the handler will be called with the data.

Specified by:

handler in interface ReadStream<Buffer>

Returns:

a reference to this, so the API can be used fluently

endHandler

HttpServerFileUpload endHandler(Handler<Void> endHandler)

Description copied from interface: ReadStream

Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

Specified by:

endHandler in interface ReadStream<Buffer>

Returns:

a reference to this, so the API can be used fluently

pause

HttpServerFileUpload pause()

Description copied from interface: ReadStream

Pause the ReadSupport. While it's paused, no data will be sent to the dataHandler

Specified by:

pause in interface ReadStream<Buffer>

Returns:

a reference to this, so the API can be used fluently

resume

HttpServerFileUpload resume()

Description copied from interface: ReadStream

Resume reading. If the ReadSupport has been paused, reading will recommence on it.

Specified by:

resume in interface ReadStream<Buffer>

Returns:

a reference to this, so the API can be used fluently

streamToFileSystem

HttpServerFileUpload streamToFileSystem(String filename)

Stream the content of this upload to the given file on storage.

Parameters:

filename - the name of the file

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. Check isSizeAvailable() to determine this

Returns:

the size of the upload (in bytes)

isSizeAvailable

boolean isSizeAvailable()

Returns:

true if the size of the upload can be retrieved via size().