Package io.vertx.rxjava3.core.http

Class HttpServerRequest

  • All Implemented Interfaces:
    ReadStream<Buffer>, StreamBase
    public class HttpServerRequest
extends Object
implements ReadStream<Buffer>
    Represents a server-side HTTP request.

    Instances are created for each request and passed to the user via a handler.

    Each instance of this class is associated with a corresponding HttpServerResponse instance via response().

    It implements ReadStream so it can be used with Pipe to pipe data with flow control.

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

    • Field Detail

      • __TYPE_ARG

        public static final io.vertx.lang.rx.TypeArg<HttpServerRequest> __TYPE_ARG

    • Constructor Detail

      • HttpServerRequest

        public HttpServerRequest​(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 Completable 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

      • handler

        public HttpServerRequest 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

      • pause

        public HttpServerRequest 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 HttpServerRequest 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 HttpServerRequest 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

      • endHandler

        public HttpServerRequest 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

      • version

        public HttpVersion version()
        Returns:
        the HTTP version of the request

      • method

        public HttpMethod method()
        Returns:
        the HTTP method for the request.

      • isSSL

        public boolean isSSL()
        Returns:
        true if this NetSocket is encrypted via SSL/TLS

      • scheme

        public String scheme()
        Returns:
        the scheme of the request

      • uri

        public String uri()
        Returns:
        the URI of the request. This is usually a relative URI

      • path

        public String path()
        Returns:
        The path part of the uri. For example /somepath/somemorepath/someresource.foo

      • query

        public String query()
        Returns:
        the query part of the uri. For example someparam=32&someotherparam=x

      • authority

        public HostAndPort authority()
        Returns:
        the request authority. For HTTP/2 the pseudo header is returned, for HTTP/1.x the header is returned or null when no such header is present. When the authority string does not carry a port, the returns -1 to indicate the scheme port is prevalent.

      • bytesRead

        public long bytesRead()
        Returns:
        the total number of bytes read for the body of the request.

      • response

        public HttpServerResponse response()
        Returns:
        the response. Each instance of this class has an HttpServerResponse instance attached to it. This is used to send the response back to the client.

      • headers

        public MultiMap headers()
        Returns:
        the headers in the request.

      • getHeader

        public String getHeader​(String headerName)
        Return the first header value with the specified name
        Parameters:
        headerName - the header name
        Returns:
        the header value

      • setParamsCharset

        public HttpServerRequest setParamsCharset​(String charset)
        Override the charset to use for decoding the query parameter map, when none is set, UTF8 is used.
        Parameters:
        charset - the charset to use for decoding query params
        Returns:
        a reference to this, so the API can be used fluently

      • getParamsCharset

        public String getParamsCharset()
        Returns:
        the charset used for decoding query parameters

      • params

        public MultiMap params()
        Returns:
        the query parameters in the request

      • params

        public MultiMap params​(boolean semicolonIsNormalChar)
        Parameters:
        semicolonIsNormalChar - whether semicolon is treated as a normal character or a query parameter separator
        Returns:
        the query parameters in the request

      • getParam

        public String getParam​(String paramName)
        Return the first param value with the specified name
        Parameters:
        paramName - the param name
        Returns:
        the param value

      • getParam

        public String getParam​(String paramName,
                       String defaultValue)
        Return the first param value with the specified name or defaultValue when the query param is not present
        Parameters:
        paramName - the param name
        defaultValue - the default value, must be non-null
        Returns:
        the param value or defaultValue when not present

      • remoteAddress

        public SocketAddress remoteAddress()
        Returns:
        the remote address for this connection, possibly null (e.g a server bound on a domain socket). If useProxyProtocol is set to true, the address returned will be of the actual connecting client.

      • localAddress

        public SocketAddress localAddress()
        Returns:
        the local address for this connection, possibly null (e.g a server bound on a domain socket) If useProxyProtocol is set to true, the address returned will be of the proxy.

      • absoluteURI

        public String absoluteURI()
        Returns:
        the absolute URI corresponding to the HTTP request

      • bodyHandler

        public HttpServerRequest bodyHandler​(Handler<Buffer> bodyHandler)
        Convenience method for receiving the entire request body in one piece.

        This saves the user having to manually setting a data and end handler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.

        Parameters:
        bodyHandler - This handler will be called after all the body has been received
        Returns:

      • body

        public Single<Buffer> body()
        Convenience method for receiving the entire request body in one piece.

        This saves you having to manually set a dataHandler and an endHandler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.

        Returns:
        a future completed with the body result

      • rxBody

        public Single<Buffer> rxBody()
        Convenience method for receiving the entire request body in one piece.

        This saves you having to manually set a dataHandler and an endHandler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.

        Returns:
        a future completed with the body result

      • end

        public Completable end()
        Returns a future signaling when the request has been fully received successfully or failed.
        Returns:
        a future completed with the body result

      • rxEnd

        public Completable rxEnd()
        Returns a future signaling when the request has been fully received successfully or failed.
        Returns:
        a future completed with the body result

      • setExpectMultipart

        public HttpServerRequest setExpectMultipart​(boolean expect)
        Call this with true if you are expecting a multi-part body to be submitted in the request. This must be called before the body of the request has been received
        Parameters:
        expect - true - if you are expecting a multi-part body
        Returns:
        a reference to this, so the API can be used fluently

      • isExpectMultipart

        public boolean isExpectMultipart()
        Returns:
        true if we are expecting a multi-part body for this request. See setExpectMultipart(boolean).

      • uploadHandler

        public HttpServerRequest uploadHandler​(Handler<HttpServerFileUpload> uploadHandler)
        Set an upload handler. The handler will get notified once a new file upload was received to allow you to deal with the file upload.
        Parameters:
        uploadHandler -
        Returns:
        a reference to this, so the API can be used fluently

      • formAttributes

        public MultiMap formAttributes()
        Returns a map of all form attributes in the request.

        Be aware that the attributes will only be available after the whole body has been received, i.e. after the request end handler has been called.

        setExpectMultipart(boolean) must be called first before trying to get the form attributes.

        Returns:
        the form attributes

      • getFormAttribute

        public String getFormAttribute​(String attributeName)
        Return the first form attribute value with the specified name
        Parameters:
        attributeName - the attribute name
        Returns:
        the attribute value

      • streamId

        public int streamId()
        Returns:
        the id of the stream of this request, when it is not yet determined, i.e the request has not been yet sent or it is not supported HTTP/1.x

      • canUpgradeToWebSocket

        public boolean canUpgradeToWebSocket()
        Returns:
        whether this request can be upgraded to a WebSocket, implying it uses HTTP/1.x and presents the correct characteristics for a proper upgrade.

      • toWebSocket

        public Single<ServerWebSocket> toWebSocket()
        Upgrade the connection of the current request to a WebSocket.

        This is an alternative way of handling WebSockets and can only be used if no WebSocket handler is set on the HttpServer, and can only be used during the upgrade request during the WebSocket handshake.

        Both handler(io.vertx.core.Handler<io.vertx.core.buffer.Buffer>) and endHandler(io.vertx.core.Handler<java.lang.Void>) will be set to get the full body of the request that is necessary to perform the WebSocket handshake.

        If you need to do an asynchronous upgrade, i.e not performed immediately in your request handler, you need to pause() the request in order to not lose HTTP events necessary to upgrade the request.

        Returns:
        a future notified with the upgraded WebSocket

      • rxToWebSocket

        public Single<ServerWebSocket> rxToWebSocket()
        Upgrade the connection of the current request to a WebSocket.

        This is an alternative way of handling WebSockets and can only be used if no WebSocket handler is set on the HttpServer, and can only be used during the upgrade request during the WebSocket handshake.

        Both handler(io.vertx.core.Handler<io.vertx.core.buffer.Buffer>) and endHandler(io.vertx.core.Handler<java.lang.Void>) will be set to get the full body of the request that is necessary to perform the WebSocket handshake.

        If you need to do an asynchronous upgrade, i.e not performed immediately in your request handler, you need to pause() the request in order to not lose HTTP events necessary to upgrade the request.

        Returns:
        a future notified with the upgraded WebSocket

      • isEnded

        public boolean isEnded()
        Has the request ended? I.e. has the entire request, including the body been read?
        Returns:
        true if ended

      • customFrameHandler

        public HttpServerRequest customFrameHandler​(Handler<HttpFrame> handler)
        Set a custom frame handler. The handler will get notified when the http stream receives an custom HTTP/2 frame. HTTP/2 permits extension of the protocol.
        Parameters:
        handler -
        Returns:
        a reference to this, so the API can be used fluently

      • streamPriority

        public StreamPriority streamPriority()
        Returns:
        the priority of the associated HTTP/2 stream for HTTP/2 otherwise null

      • streamPriorityHandler

        public HttpServerRequest streamPriorityHandler​(Handler<StreamPriority> handler)
        Set an handler for stream priority changes

        This is not implemented for HTTP/1.x.

        Parameters:
        handler - the handler to be called when stream priority changes
        Returns:

      • getCookie

        public Cookie getCookie​(String name)
        Get the cookie with the specified name. NOTE: this will return just the 1st Cookie that matches the given name, to get all cookies for this name see: cookies(java.lang.String)
        Parameters:
        name - the cookie name
        Returns:
        the cookie or null if not found.

      • getCookie

        public Cookie getCookie​(String name,
                        String domain,
                        String path)
        Get the cookie with the specified .
        Parameters:
        name - the cookie name
        domain - the cookie domain
        path - the cookie path
        Returns:
        the cookie or null if not found.

      • cookieCount

        public int cookieCount()
        Returns:
        the number of cookies in the cookie jar.

      • cookies

        public Set<Cookie> cookies​(String name)
        Returns a read only set of parsed cookies that match the given name, or an empty set. Several cookies may share the same name but have different keys. A cookie is unique by its tuple. The set entries are references to the request original set. This means that performing property changes in the cookie objects will affect the original object too. NOTE: the returned is read-only. This means any attempt to modify (add or remove to the set), will throw UnsupportedOperationException.
        Parameters:
        name - the name to be matches
        Returns:
        the matching cookies or empty set

      • cookies

        public Set<Cookie> cookies()
        Returns a modifiable set of parsed cookies from the COOKIE header. Several cookies may share the same name but have different keys. A cookie is unique by its tuple. Request cookies are directly linked to response cookies. Any modification to a cookie object in the returned set will mark the cookie to be included in the HTTP response. Removing a cookie from the set, will also mean that it will be removed from the response, regardless if it was modified or not.
        Returns:
        a set with all cookies in the cookie jar.

      • routed

        public HttpServerRequest routed​(String route)
        Marks this request as being routed to the given route. This is purely informational and is being provided to metrics.
        Parameters:
        route - The route this request has been routed to.
        Returns:

      • getHeader

        public String getHeader​(CharSequence headerName)
        Return the first header value with the specified name
        Parameters:
        headerName - the header name
        Returns:
        the header value

      • sslSession

        public SSLSession sslSession()
        Returns:
        SSLSession associated with the underlying socket. Returns null if connection is not SSL.