Package io.vertx.reactivex.core.http

Class HttpServerFileUpload

  • All Implemented Interfaces:
    io.vertx.lang.rx.RxDelegate, ReadStream<Buffer>, StreamBase
    public class HttpServerFileUpload
extends Object
implements io.vertx.lang.rx.RxDelegate, ReadStream<Buffer>
    Represents an file upload from an HTML FORM.

    NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

    • Constructor Detail

      • HttpServerFileUpload

        public HttpServerFileUpload​(Object delegate)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • pipe

        public Pipe<Buffer> pipe()
        Pause this stream and return a to transfer the elements of this stream to a destination .

        The stream will be resumed when the pipe will be wired to a WriteStream.

        Specified by:
        pipe in interface ReadStream<Buffer>
        Returns:
        a pipe

      • pipeTo

        public Future<Void> pipeTo​(WriteStream<Buffer> dst)
        Pipe this ReadStream to the WriteStream.

        Elements emitted by this stream will be written to the write stream until this stream ends or fails.

        Specified by:
        pipeTo in interface ReadStream<Buffer>
        Parameters:
        dst - the destination write stream
        Returns:
        a future notified when the write stream will be ended with the outcome

      • rxPipeTo

        public Completable rxPipeTo​(WriteStream<Buffer> dst)
        Pipe this ReadStream to the WriteStream.

        Elements emitted by this stream will be written to the write stream until this stream ends or fails.

        Specified by:
        rxPipeTo in interface ReadStream<Buffer>
        Parameters:
        dst - the destination write stream
        Returns:
        a future notified when the write stream will be ended with the outcome

      • endHandler

        public 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

        public HttpServerFileUpload pause()
        Description copied from interface: ReadStream
        Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

        While it's paused, no data will be sent to the data handler.

        Specified by:
        pause in interface ReadStream<Buffer>
        Returns:
        a reference to this, so the API can be used fluently

      • resume

        public HttpServerFileUpload resume()
        Description copied from interface: ReadStream
        Resume reading, and sets the buffer in flowing mode.

        If the ReadStream 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

      • fetch

        public HttpServerFileUpload fetch​(long amount)
        Description copied from interface: ReadStream
        Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.
        Specified by:
        fetch in interface ReadStream<Buffer>
        Returns:
        a reference to this, so the API can be used fluently

      • streamToFileSystem

        public 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
        Returns:

      • rxStreamToFileSystem

        public Completable rxStreamToFileSystem​(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
        Returns:

      • cancelStreamToFileSystem

        public boolean cancelStreamToFileSystem()
        Try to cancel the file system streaming, the streamed file will be deleted.
        Returns:
        true when the stream is cancelled, otherwise it means that stream is finished

      • filename

        public String filename()
        Returns:
        the filename which was used when upload the file.

      • name

        public String name()
        Returns:
        the name of the attribute

      • contentType

        public String contentType()
        Returns:
        the content type for the upload

      • contentTransferEncoding

        public String contentTransferEncoding()
        Returns:
        the contentTransferEncoding for the upload

      • charset

        public String charset()
        Returns:
        the charset for the upload

      • size

        public 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

        public boolean isSizeAvailable()
        Returns:
        true if the size of the upload can be retrieved via size().