public class HttpServerRequest extends Object implements ReadStream<Buffer>
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
Pump to pump data with flow control.
NOTE: This class has been automatically generated from the
original non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<HttpServerRequest> |
__TYPE_ARG |
| Constructor and Description |
|---|
HttpServerRequest(HttpServerRequest delegate) |
HttpServerRequest(Object delegate) |
| Modifier and Type | Method and Description |
|---|---|
String |
absoluteURI() |
HttpServerRequest |
bodyHandler(Handler<Buffer> bodyHandler)
Convenience method for receiving the entire request body in one piece.
|
long |
bytesRead() |
HttpConnection |
connection() |
int |
cookieCount() |
HttpServerRequest |
customFrameHandler(Handler<HttpFrame> handler)
Set a custom frame handler.
|
HttpServerRequest |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
boolean |
equals(Object o) |
HttpServerRequest |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
HttpServerRequest |
fetch(long amount)
Fetch the specified
amount of elements. |
MultiMap |
formAttributes()
Returns a map of all form attributes in the request.
|
Cookie |
getCookie(String name)
Get the cookie with the specified name.
|
HttpServerRequest |
getDelegate() |
String |
getFormAttribute(String attributeName)
Return the first form attribute value with the specified name
|
String |
getHeader(CharSequence headerName)
Return the first header value with the specified name
|
String |
getHeader(String headerName)
Return the first header value with the specified name
|
String |
getParam(String paramName)
Return the first param value with the specified name
|
HttpServerRequest |
handler(Handler<Buffer> handler)
Set a data handler.
|
int |
hashCode() |
MultiMap |
headers() |
String |
host() |
boolean |
isEnded()
Has the request ended? I.e.
|
boolean |
isExpectMultipart() |
boolean |
isSSL() |
SocketAddress |
localAddress() |
HttpMethod |
method() |
NetSocket |
netSocket()
Deprecated.
|
static HttpServerRequest |
newInstance(HttpServerRequest arg) |
MultiMap |
params() |
String |
path() |
HttpServerRequest |
pause()
Pause the
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
Pipe<Buffer> |
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .
|
void |
pipeTo(WriteStream<Buffer> dst)
Like
ReadStream.pipeTo(io.vertx.reactivex.core.streams.WriteStream<T>) but with no completion handler. |
void |
pipeTo(WriteStream<Buffer> dst,
Handler<AsyncResult<Void>> handler)
Pipe this
ReadStream to the WriteStream. |
String |
query() |
String |
rawMethod() |
SocketAddress |
remoteAddress() |
HttpServerResponse |
response() |
HttpServerRequest |
resume()
Resume reading, and sets the buffer in
flowing mode. |
Completable |
rxPipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream. |
Single<NetSocket> |
rxToNetSocket()
Establish a TCP tunnel with the client.
|
Single<ServerWebSocket> |
rxToWebSocket()
Upgrade the connection of the current request to a WebSocket.
|
String |
scheme() |
HttpServerRequest |
setExpectMultipart(boolean expect)
Call this with true if you are expecting a multi-part body to be submitted in the request.
|
SSLSession |
sslSession() |
int |
streamId() |
StreamPriority |
streamPriority() |
HttpServerRequest |
streamPriorityHandler(Handler<StreamPriority> handler)
Set an handler for stream priority changes
|
Flowable<Buffer> |
toFlowable() |
void |
toNetSocket(Handler<AsyncResult<NetSocket>> handler)
Establish a TCP tunnel with the client.
|
Observable<Buffer> |
toObservable() |
String |
toString() |
void |
toWebSocket(Handler<AsyncResult<ServerWebSocket>> handler)
Upgrade the connection of the current request to a WebSocket.
|
ServerWebSocket |
upgrade()
Deprecated.
|
HttpServerRequest |
uploadHandler(Handler<HttpServerFileUpload> uploadHandler)
Set an upload handler.
|
String |
uri() |
HttpVersion |
version() |
clone, finalize, getClass, notify, notifyAll, wait, wait, waitnewInstance, newInstancenewInstancepublic static final io.vertx.lang.rx.TypeArg<HttpServerRequest> __TYPE_ARG
public HttpServerRequest(HttpServerRequest delegate)
public HttpServerRequest(Object delegate)
public HttpServerRequest getDelegate()
getDelegate in interface ReadStream<Buffer>getDelegate in interface StreamBasepublic Observable<Buffer> toObservable()
toObservable in interface ReadStream<Buffer>public Flowable<Buffer> toFlowable()
toFlowable in interface ReadStream<Buffer>public Pipe<Buffer> pipe()
WriteStream.pipe in interface ReadStream<Buffer>public void pipeTo(WriteStream<Buffer> dst)
ReadStream.pipeTo(io.vertx.reactivex.core.streams.WriteStream<T>) but with no completion handler.pipeTo in interface ReadStream<Buffer>dst - public void pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
pipeTo in interface ReadStream<Buffer>dst - the destination write streamhandler - public Completable rxPipeTo(WriteStream<Buffer> dst)
ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
dst - the destination write streampublic HttpServerRequest exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBasehandler - the exception handlerpublic HttpServerRequest handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>public HttpServerRequest pause()
ReadStreamReadStream, 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.
pause in interface ReadStream<Buffer>public HttpServerRequest resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>public HttpServerRequest fetch(long amount)
ReadStreamamount 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.fetch in interface ReadStream<Buffer>public HttpServerRequest endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>public HttpVersion version()
public HttpMethod method()
public String rawMethod()
public boolean isSSL()
NetSocket is encrypted via SSL/TLSpublic String scheme()
public String uri()
public String path()
public String query()
public String host()
public long bytesRead()
public HttpServerResponse response()
HttpServerResponse instance attached to it. This is used to send the response back to the client.public MultiMap headers()
public String getHeader(String headerName)
headerName - the header namepublic MultiMap params()
public String getParam(String paramName)
paramName - the param namepublic SocketAddress remoteAddress()
null (e.g a server bound on a domain socket)public SocketAddress localAddress()
null (e.g a server bound on a domain socket)public String absoluteURI()
public HttpServerRequest bodyHandler(Handler<Buffer> bodyHandler)
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.
bodyHandler - This handler will be called after all the body has been received@Deprecated public NetSocket netSocket()
CONNECT requests, a 200 response is sent with no content-length header set
before returning the socket.
server.requestHandler(req -> {
if (req.method() == HttpMethod.CONNECT) {
// Send a 200 response to accept the connect
NetSocket socket = req.netSocket();
socket.handler(buff -> {
socket.write(buff);
});
}
...
});
For other HTTP/1 requests once you have called this method, you must handle writing to the connection yourself using
the net socket, the server request instance will no longer be usable as normal. USE THIS WITH CAUTION! Writing to the socket directly if you don't know what you're
doing can easily break the HTTP protocol.
With HTTP/2, a 200 response is always sent with no content-length header set before returning the socket
like in the CONNECT case above.
public void toNetSocket(Handler<AsyncResult<NetSocket>> handler)
This must be called only for CONNECT HTTP method and before any response is sent.
Calling this sends a 200 response with no content-length header set and
then provides the NetSocket for handling the created tunnel. Any HTTP header set on the
response before calling this method will be sent.
server.requestHandler(req -> {
if (req.method() == HttpMethod.CONNECT) {
// Send a 200 response to accept the connect
NetSocket socket = req.netSocket();
socket.handler(buff -> {
socket.write(buff);
});
}
...
});
handler - the completion handlerpublic Single<NetSocket> rxToNetSocket()
This must be called only for CONNECT HTTP method and before any response is sent.
Calling this sends a 200 response with no content-length header set and
then provides the NetSocket for handling the created tunnel. Any HTTP header set on the
response before calling this method will be sent.
server.requestHandler(req -> {
if (req.method() == HttpMethod.CONNECT) {
// Send a 200 response to accept the connect
NetSocket socket = req.netSocket();
socket.handler(buff -> {
socket.write(buff);
});
}
...
});
public HttpServerRequest setExpectMultipart(boolean expect)
expect - true - if you are expecting a multi-part bodypublic boolean isExpectMultipart()
setExpectMultipart(boolean).public HttpServerRequest uploadHandler(Handler<HttpServerFileUpload> uploadHandler)
uploadHandler - public MultiMap formAttributes()
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.
public String getFormAttribute(String attributeName)
attributeName - the attribute namepublic int streamId()
@Deprecated public ServerWebSocket upgrade()
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.
public void toWebSocket(Handler<AsyncResult<ServerWebSocket>> handler)
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.reactivex.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.
handler - the completion handlerpublic Single<ServerWebSocket> rxToWebSocket()
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.reactivex.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.
public boolean isEnded()
public HttpServerRequest customFrameHandler(Handler<HttpFrame> handler)
handler - public HttpConnection connection()
HttpConnection associated with this requestpublic StreamPriority streamPriority()
nullpublic HttpServerRequest streamPriorityHandler(Handler<StreamPriority> handler)
This is not implemented for HTTP/1.x.
handler - the handler to be called when stream priority changespublic Cookie getCookie(String name)
name - the cookie namepublic int cookieCount()
public String getHeader(CharSequence headerName)
headerName - the header namepublic SSLSession sslSession()
public static HttpServerRequest newInstance(HttpServerRequest arg)
Copyright © 2021 Eclipse. All rights reserved.