Package io.vertx.rxjava3.core.http

Class HttpClientRequest

  • All Implemented Interfaces:
    StreamBase, WriteStream<Buffer>
    public class HttpClientRequest
extends Object
implements WriteStream<Buffer>
    Represents a client-side HTTP request.

    Instances are created by an HttpClient instance, via one of the methods corresponding to the specific HTTP methods, or the generic request methods. On creation the request will not have been written to the wire.

    Once a request has been obtained, headers can be set on it, and data can be written to its body if required. Once you are ready to send the request, one of the end(java.lang.String) methods should be called.

    Nothing is actually sent until the request has been internally assigned an HTTP connection.

    The HttpClient instance will return an instance of this class immediately, even if there are no HTTP connections available in the pool. Any requests sent before a connection is assigned will be queued internally and actually sent when an HTTP connection becomes available from the pool.

    The headers of the request are queued for writing either when the end(java.lang.String) method is called, or, when the first part of the body is written, whichever occurs first.

    This class supports both chunked and non-chunked HTTP.

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

    An example of using this class is as follows:

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

    • Constructor Detail

      • HttpClientRequest

        public HttpClientRequest​(Object delegate)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • write

        public io.reactivex.rxjava3.core.Completable write​(Buffer data)
        Same as but with an handler called when the operation completes
        Specified by:
        write in interface WriteStream<Buffer>
        Parameters:
        data -
        Returns:

      • rxWrite

        public io.reactivex.rxjava3.core.Completable rxWrite​(Buffer data)
        Same as but with an handler called when the operation completes
        Specified by:
        rxWrite in interface WriteStream<Buffer>
        Parameters:
        data -
        Returns:

      • setWriteQueueMaxSize

        public HttpClientRequest setWriteQueueMaxSize​(int maxSize)
        Description copied from interface: WriteStream
        Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize items in the write queue. This is used as an indicator by classes such as Pipe to provide flow control.

        The value is defined by the implementation of the stream, e.g in bytes for a NetSocket, etc...

        Specified by:
        setWriteQueueMaxSize in interface WriteStream<Buffer>
        Parameters:
        maxSize - the max size of the write stream
        Returns:
        a reference to this, so the API can be used fluently

      • drainHandler

        public HttpClientRequest drainHandler​(Handler<Void> handler)
        Description copied from interface: WriteStream
        Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See Pipe for an example of this being used.

        The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to maxSize / 2.

        Specified by:
        drainHandler in interface WriteStream<Buffer>
        Parameters:
        handler - the handler
        Returns:
        a reference to this, so the API can be used fluently

      • authority

        public HttpClientRequest authority​(HostAndPort authority)
        Override the request authority, when using HTTP/1.x this overrides the request host header, when using HTTP/2 this sets the authority pseudo header. When the port is a negative value, the default scheme port will be used.

        The default request authority is the server host and port when connecting to the server.

        Parameters:
        authority - override the request authority
        Returns:
        a reference to this, so the API can be used fluently

      • setHost

        @Deprecated
public HttpClientRequest setHost​(String host)
        Deprecated.
        Set the host value of the HTTP/1.1 host header or HTTP/2 authority pseudo header

        The initial value is the same as the server socket address host.

        Keep in mind that changing this value won't change the actual server socket address for this request.

        Parameters:
        host - the host part of the HTTP/1.1 host header or HTTP/2 authority pseudo header
        Returns:
        a reference to this, so the API can be used fluently

      • getHost

        @Deprecated
public String getHost()
        Deprecated.
        Returns:
        the host value of the HTTP/1.1 host header or HTTP/2 authority pseudo header

      • setPort

        @Deprecated
public HttpClientRequest setPort​(int port)
        Deprecated.
        Set the port value of the HTTP/1.1 host header or HTTP/2 authority pseudo header

        Keep in mind that this won't change the actual server socket address for this request.

        The initial value is the same than the server socket address port.

        Parameters:
        port - the port part of the HTTP/1.1 host header or HTTP/2 authority pseudo header
        Returns:
        a reference to this, so the API can be used fluently

      • getPort

        @Deprecated
public int getPort()
        Deprecated.
        Returns:
        the port value of the HTTP/1.1 host header or HTTP/2 authority pseudo header

      • setFollowRedirects

        public HttpClientRequest setFollowRedirects​(boolean followRedirects)
        Set the request to follow HTTP redirects up to HttpClientOptions.
        Parameters:
        followRedirects - true to follow HTTP redirects
        Returns:
        a reference to this, so the API can be used fluently

      • setMaxRedirects

        public HttpClientRequest setMaxRedirects​(int maxRedirects)
        Set the max number of HTTP redirects this request will follow. The default is 0 which means no redirects.
        Parameters:
        maxRedirects - the number of HTTP redirect to follow
        Returns:
        a reference to this, so the API can be used fluently

      • setChunked

        public HttpClientRequest setChunked​(boolean chunked)
        If chunked is true then the request will be set into HTTP chunked mode
        Parameters:
        chunked - true if chunked encoding
        Returns:
        a reference to this, so the API can be used fluently

      • isChunked

        public boolean isChunked()
        Returns:
        Is the request chunked?

      • getMethod

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

      • setMethod

        public HttpClientRequest setMethod​(HttpMethod method)
        Set the HTTP method for this request.
        Parameters:
        method - the HTTP method
        Returns:
        a reference to this, so the API can be used fluently

      • absoluteURI

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

      • getURI

        public String getURI()
        Returns:
        The URI of the request.

      • setURI

        public HttpClientRequest setURI​(String uri)
        Set the request uri.
        Parameters:
        uri - the request uri
        Returns:
        a reference to this, so the API can be used fluently

      • 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

      • headers

        public MultiMap headers()
        Returns:
        The HTTP headers

      • putHeader

        public HttpClientRequest putHeader​(String name,
                                   String value)
        Put an HTTP header
        Parameters:
        name - The header name
        value - The header value
        Returns:
        a reference to this, so the API can be used fluently

      • version

        public HttpVersion version()
        Returns:
        the HTTP version for this request

      • continueHandler

        public HttpClientRequest continueHandler​(Handler<Void> handler)
        If you send an HTTP request with the header Expect set to the value 100-continue and the server responds with an interim HTTP response with a status code of 100 and a Continue handler has been set using this method, then the handler will be called.

        You can then continue to write data to the request body and later end it. This is normally used in conjunction with the sendHead() method to force the request header to be written before the request has ended.

        Parameters:
        handler -
        Returns:
        a reference to this, so the API can be used fluently

      • earlyHintsHandler

        public HttpClientRequest earlyHintsHandler​(Handler<MultiMap> handler)
        If the server responds with an interim HTTP response with a status code of 103 and a Early Hints handler has been set using this method, then the handler will be called.
        Parameters:
        handler -
        Returns:
        a reference to this, so the API can be used fluently

      • sendHead

        public io.reactivex.rxjava3.core.Completable sendHead()
        Like sendHead() but with an handler after headers have been sent. The handler will be called with the HttpVersion if it can be determined or null otherwise.

        Returns:

      • rxSendHead

        public io.reactivex.rxjava3.core.Completable rxSendHead()
        Like sendHead() but with an handler after headers have been sent. The handler will be called with the HttpVersion if it can be determined or null otherwise.

        Returns:

      • connect

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> connect()
        Create an HTTP tunnel to the server.

        Send HTTP request headers to the server, then configures the transport to exchange raw buffers when the server replies with an appropriate response:

        • 200 for HTTP CONNECT method
        • 101 for HTTP/1.1 GET with Upgrade connection header

        The handler is called after response headers are received.

        Use HttpClientResponse.netSocket() to get a for interacting more conveniently with the server.

        HTTP/1.1 pipe-lined requests are not supported.f

        Returns:

      • rxConnect

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> rxConnect()
        Create an HTTP tunnel to the server.

        Send HTTP request headers to the server, then configures the transport to exchange raw buffers when the server replies with an appropriate response:

        • 200 for HTTP CONNECT method
        • 101 for HTTP/1.1 GET with Upgrade connection header

        The handler is called after response headers are received.

        Use HttpClientResponse.netSocket() to get a for interacting more conveniently with the server.

        HTTP/1.1 pipe-lined requests are not supported.f

        Returns:

      • response

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> response()
        Set a callback for the associated HttpClientResponse.

        This method does not modify the current request being sent.

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

      • rxResponse

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> rxResponse()
        Set a callback for the associated HttpClientResponse.

        This method does not modify the current request being sent.

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

      • send

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> send()
        Send the request with an empty body.
        Returns:

      • rxSend

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> rxSend()
        Send the request with an empty body.
        Returns:

      • send

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> send​(String body)
        Send the request with a string body.
        Parameters:
        body -
        Returns:

      • rxSend

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> rxSend​(String body)
        Send the request with a string body.
        Parameters:
        body -
        Returns:

      • send

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> send​(Buffer body)
        Send the request with a buffer body.
        Parameters:
        body -
        Returns:

      • rxSend

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> rxSend​(Buffer body)
        Send the request with a buffer body.
        Parameters:
        body -
        Returns:

      • send

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> send​(io.reactivex.rxjava3.core.Flowable<Buffer> body)
        Send the request with a stream body.

        If the HttpHeaders is set then the request assumes this is the length of the {stream}, otherwise the request will set a chunked HttpHeaders.

        Parameters:
        body -
        Returns:

      • rxSend

        public io.reactivex.rxjava3.core.Single<HttpClientResponse> rxSend​(io.reactivex.rxjava3.core.Flowable<Buffer> body)
        Send the request with a stream body.

        If the HttpHeaders is set then the request assumes this is the length of the {stream}, otherwise the request will set a chunked HttpHeaders.

        Parameters:
        body -
        Returns:

      • end

        public io.reactivex.rxjava3.core.Completable end​(String chunk)
        Same as end(java.lang.String) but with an handler called when the operation completes
        Parameters:
        chunk -
        Returns:

      • rxEnd

        public io.reactivex.rxjava3.core.Completable rxEnd​(String chunk)
        Same as end(java.lang.String) but with an handler called when the operation completes
        Parameters:
        chunk -
        Returns:

      • end

        public io.reactivex.rxjava3.core.Completable end​(String chunk,
                                                 String enc)
        Same as end(java.lang.String) but with an handler called when the operation completes
        Parameters:
        chunk -
        enc -
        Returns:

      • rxEnd

        public io.reactivex.rxjava3.core.Completable rxEnd​(String chunk,
                                                   String enc)
        Same as end(java.lang.String) but with an handler called when the operation completes
        Parameters:
        chunk -
        enc -
        Returns:

      • end

        public io.reactivex.rxjava3.core.Completable end​(Buffer chunk)
        Same as end(java.lang.String) but with an handler called when the operation completes
        Specified by:
        end in interface WriteStream<Buffer>
        Parameters:
        chunk -
        Returns:

      • rxEnd

        public io.reactivex.rxjava3.core.Completable rxEnd​(Buffer chunk)
        Same as end(java.lang.String) but with an handler called when the operation completes
        Specified by:
        rxEnd in interface WriteStream<Buffer>
        Parameters:
        chunk -
        Returns:

      • end

        public io.reactivex.rxjava3.core.Completable end()
        Same as end(java.lang.String) but with an handler called when the operation completes
        Specified by:
        end in interface WriteStream<Buffer>
        Returns:

      • setTimeout

        public HttpClientRequest setTimeout​(long timeoutMs)
        Set's the amount of time after which if the request does not return any data within the timeout period an TimeoutException will be passed to the exception handler (if provided) and the request will be closed.

        Calling this method more than once has the effect of canceling any existing timeout and starting the timeout from scratch.

        Parameters:
        timeoutMs - The quantity of time in milliseconds.
        Returns:
        a reference to this, so the API can be used fluently

      • pushHandler

        public HttpClientRequest pushHandler​(Handler<HttpClientRequest> handler)
        Set a push handler for this request.

        The handler is called when the client receives a push promise from the server. The handler can be called multiple times, for each push promise.

        The handler is called with a read-only HttpClientRequest, the following methods can be called:

        In addition the handler should call the response() method to set an handler to process the response.

        Parameters:
        handler - the handler
        Returns:
        a reference to this, so the API can be used fluently

      • reset

        public boolean reset()
        Reset this stream with the error code 0.
        Returns:

      • reset

        public boolean reset​(long code)
        Reset this request:

        • for HTTP/2, this performs send an HTTP/2 reset frame with the specified error code
        • for HTTP/1.x, this closes the connection when the current request is inflight

        When the request has not yet been sent, the request will be aborted and false is returned as indicator.

        Parameters:
        code - the error code
        Returns:
        true when reset has been performed

      • reset

        public boolean reset​(long code,
                     Throwable cause)
        Reset this request:

        • for HTTP/2, send an HTTP/2 reset frame with the specified error code
        • for HTTP/1.x, close the connection when the current request is inflight

        When the request has not yet been sent, the request will be aborted and false is returned as indicator.

        Parameters:
        code - the error code
        cause - an optional cause that can be attached to the error code
        Returns:
        true when reset has been performed

      • writeCustomFrame

        public HttpClientRequest writeCustomFrame​(int type,
                                          int flags,
                                          Buffer payload)
        Write an HTTP/2 frame to the request, allowing to extend the HTTP/2 protocol.

        The frame is sent immediatly and is not subject to flow control.

        This method must be called after the request headers have been sent and only for the protocol HTTP/2. The sendHead() should be used for this purpose.

        Parameters:
        type - the 8-bit frame type
        flags - the 8-bit frame flags
        payload - the frame payload
        Returns:
        a reference to this, so the API can be used fluently

      • streamId

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

      • setStreamPriority

        public HttpClientRequest setStreamPriority​(StreamPriority streamPriority)
        Sets the priority of the associated stream.

        This is not implemented for HTTP/1.x.

        Parameters:
        streamPriority - the priority of this request's stream
        Returns:

      • getStreamPriority

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

      • putHeader

        public HttpClientRequest putHeader​(String name,
                                   Iterable<String> values)
        Put an HTTP header with multiple values
        Parameters:
        name - The header name
        values - The header values
        Returns: