Vert.x 4.5.13 · io.vertx.core.http.impl.Http2ServerRequest

Modifier and Type	Field and Description
private String	absoluteURI
private MultiMap	attributes
protected final ContextInternal	context
private Handler<HttpFrame>	customFrameHandler
private boolean	ended
private HttpEventHandler	eventHandler
private boolean	expectMultipart
private final MultiMap	headersMap
private static final Logger	log
private MultiMap	params
private Charset	paramsCharset
private HttpPostRequestDecoder	postRequestDecoder
protected final Http2ServerResponse	response
private boolean	semicolonIsNormalCharInParams
private final String	serverOrigin
protected final Http2ServerStream	stream
private Handler<StreamPriority>	streamPriorityHandler
private Handler<HttpServerFileUpload>	uploadHandler

Access	Constructor and Description
pack-priv	Http2ServerRequest(Http2ServerStream stream, String serverOrigin, Http2Headers headers, String contentEncoding)

Modifier and Type	Method and Description
public String	absoluteURI() Implements io.vertx.core.spi.observability.HttpRequest.absoluteURI, io.vertx.core.http.HttpServerRequest.absoluteURI.
public @Nullable HostAndPort	authority() Implements io.vertx.core.http.HttpServerRequest.authority.
public synchronized Future<Buffer>	body() Implements io.vertx.core.http.HttpServerRequest.body. Convenience method for receiving the entire request body in one piece.
public long	bytesRead() Implements io.vertx.core.http.HttpServerRequest.bytesRead.
private void	checkEnded()
public HttpConnection	connection() Implements io.vertx.core.http.HttpServerRequest.connection.
public Context	context() Implements abstract io.vertx.core.http.impl.HttpServerRequestInternal.context.
public Set<Cookie>	cookies() Implements io.vertx.core.http.HttpServerRequest.cookies. Returns a modifiable set of parsed cookies from the `COOKIE` header.
public Set<Cookie>	cookies(String the name to be matches name) Implements io.vertx.core.http.HttpServerRequest.cookies. Returns a read only set of parsed cookies that match the given name, or an empty set.
public HttpServerRequest	customFrameHandler(Handler<HttpFrame> handler) Implements io.vertx.core.http.HttpServerRequest.customFrameHandler. Set a custom frame handler.
public DecoderResult	decoderResult() Implements io.vertx.core.http.HttpServerRequest.decoderResult.
public void	dispatch(Handler<HttpServerRequest> handler) Implements io.vertx.core.http.impl.Http2ServerStreamHandler.dispatch.
public synchronized Future<Void>	end() Implements io.vertx.core.http.HttpServerRequest.end. Returns a future signaling when the request has been fully received successfully or failed.
public HttpServerRequest	endHandler(Handler<Void> handler) Implements io.vertx.core.http.HttpServerRequest.endHandler.
private HttpEventHandler	eventHandler(boolean create)
public HttpServerRequest	exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.http.HttpServerRequest.exceptionHandler.
public HttpServerRequest	fetch(long amount) Implements io.vertx.core.http.HttpServerRequest.fetch. Fetch the specified `amount` of elements.
public MultiMap	formAttributes() Implements io.vertx.core.http.HttpServerRequest.formAttributes. Returns a map of all form attributes in the request.
public Cookie	getCookie(String the cookie name name) Implements io.vertx.core.http.HttpServerRequest.getCookie. Get the cookie with the specified name.
public Cookie	getCookie(String the cookie name name, String the cookie domain domain, String the cookie path path) Implements io.vertx.core.http.HttpServerRequest.getCookie. Get the cookie with the specified `<name, domain, path>`.
public String	getFormAttribute(String the attribute name attributeName) Implements io.vertx.core.http.HttpServerRequest.getFormAttribute. Return the first form attribute value with the specified name
public String	getParamsCharset() Implements io.vertx.core.http.HttpServerRequest.getParamsCharset.
public void	handleClose() Implements io.vertx.core.http.impl.Http2ServerStreamHandler.handleClose.
public void	handleCustomFrame(HttpFrame frame) Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handleCustomFrame.
public void	handleData(Buffer data) Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handleData. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element.
public void	handleEnd(MultiMap trailers) Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handleEnd.
public void	handleException(Throwable cause) Implements io.vertx.core.http.impl.Http2ServerStreamHandler.handleException.
public void	handlePriorityChange(StreamPriority streamPriority) Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handlePriorityChange.
public HttpServerRequest	handler(Handler<Buffer> handler) Implements io.vertx.core.http.HttpServerRequest.handler.
public void	handleReset(long errorCode) Implements io.vertx.core.http.impl.Http2ServerStreamHandler.handleReset.
public MultiMap	headers() Implements io.vertx.core.spi.observability.HttpRequest.headers, io.vertx.core.http.HttpServerRequest.headers.
public String	host() Implements io.vertx.core.http.HttpServerRequest.host.
public int	id() Implements io.vertx.core.spi.observability.HttpRequest.id.
public boolean	isEnded() Implements io.vertx.core.http.HttpServerRequest.isEnded. Has the request ended?
public boolean	isExpectMultipart() Implements io.vertx.core.http.HttpServerRequest.isExpectMultipart.
public HttpMethod	method() Implements io.vertx.core.spi.observability.HttpRequest.method, io.vertx.core.http.HttpServerRequest.method.
public Object	metric() Implements abstract io.vertx.core.http.impl.HttpServerRequestInternal.metric.
private void	notifyException(Throwable failure)
public MultiMap	params(boolean whether semicolon is treated as a normal character or a query parameter separator semicolonIsNormalChar) Implements io.vertx.core.http.HttpServerRequest.params.
public String	path() Implements io.vertx.core.http.HttpServerRequest.path.
public HttpServerRequest	pause() Implements io.vertx.core.http.HttpServerRequest.pause. Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
public X509Certificate[]	peerCertificateChain() Implements io.vertx.core.http.HttpServerRequest.peerCertificateChain. References Deprecated `X509Certificate` is deprecated or references (maybe indirectly) at least one deprecated element. Note Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on.
public String	query() Implements io.vertx.core.http.HttpServerRequest.query.
public SocketAddress	remoteAddress() Overrides default io.vertx.core.http.HttpServerRequest.remoteAddress. Implements io.vertx.core.spi.observability.HttpRequest.remoteAddress.
public Http2ServerResponse	response() Implements io.vertx.core.http.impl.Http2ServerStreamHandler.response, io.vertx.core.http.HttpServerRequest.response.
public HttpServerRequest	resume() Implements io.vertx.core.http.HttpServerRequest.resume. Resume reading, and sets the buffer in `flowing` mode.
public HttpServerRequest	routed(String The route this request has been routed to. route) Overrides default io.vertx.core.http.HttpServerRequest.routed. Marks this request as being routed to the given route.
public String	scheme() Implements io.vertx.core.http.HttpServerRequest.scheme.
public HttpServerRequest	setExpectMultipart(boolean true - if you are expecting a multi-part body expect) Implements io.vertx.core.http.HttpServerRequest.setExpectMultipart. Call this with true if you are expecting a multi-part body to be submitted in the request.
public HttpServerRequest	setParamsCharset(String the charset to use for decoding query params charset) Implements io.vertx.core.http.HttpServerRequest.setParamsCharset. Override the charset to use for decoding the query parameter map, when none is set, `UTF8` is used.
public int	streamId() Overrides default io.vertx.core.http.HttpServerRequest.streamId.
public StreamPriority	streamPriority() Overrides default io.vertx.core.http.HttpServerRequest.streamPriority.
public HttpServerRequest	streamPriorityHandler(Handler<StreamPriority> the handler to be called when stream priority changes handler) Implements io.vertx.core.http.HttpServerRequest.streamPriorityHandler. Set an handler for stream priority changes This is not implemented for HTTP/1.x.
public Future<NetSocket>	toNetSocket() Implements io.vertx.core.http.HttpServerRequest.toNetSocket. Like `toNetSocket(Handler)` but returns a `Future` of the asynchronous result
public Future<ServerWebSocket>	toWebSocket() Implements io.vertx.core.http.HttpServerRequest.toWebSocket. Like `toWebSocket(Handler)` but returns a `Future` of the asynchronous result
public HttpServerRequest	uploadHandler(@Nullable Handler<HttpServerFileUpload> handler)
public String	uri() Implements io.vertx.core.spi.observability.HttpRequest.uri, io.vertx.core.http.HttpServerRequest.uri.
public HttpVersion	version() Implements io.vertx.core.http.HttpServerRequest.version.

absoluteURI	back to summary
private String absoluteURI

attributes	back to summary
private MultiMap attributes

context	back to summary
protected final ContextInternal context

customFrameHandler	back to summary
private Handler<HttpFrame> customFrameHandler

ended	back to summary
private boolean ended

eventHandler	back to summary
private HttpEventHandler eventHandler

expectMultipart	back to summary
private boolean expectMultipart

headersMap	back to summary
private final MultiMap headersMap

log	back to summary
private static final Logger log

params	back to summary
private MultiMap params

paramsCharset	back to summary
private Charset paramsCharset

postRequestDecoder	back to summary
private HttpPostRequestDecoder postRequestDecoder

response	back to summary
protected final Http2ServerResponse response

semicolonIsNormalCharInParams	back to summary
private boolean semicolonIsNormalCharInParams

serverOrigin	back to summary
private final String serverOrigin

stream	back to summary
protected final Http2ServerStream stream

streamPriorityHandler	back to summary
private Handler<StreamPriority> streamPriorityHandler

uploadHandler	back to summary
private Handler<HttpServerFileUpload> uploadHandler

Http2ServerRequest	back to summary
pack-priv Http2ServerRequest(Http2ServerStream stream, String serverOrigin, Http2Headers headers, String contentEncoding)

Method Detail

absoluteURI	back to summary
public String absoluteURI() Implements io.vertx.core.spi.observability.HttpRequest.absoluteURI, io.vertx.core.http.HttpServerRequest.absoluteURI. Returns:String Doc from io.vertx.core.spi.observability.HttpRequest.absoluteURI. the request absolute URI Annotations @Override

absoluteURI

back to summary

public String absoluteURI()

Implements io.vertx.core.spi.observability.HttpRequest.absoluteURI, io.vertx.core.http.HttpServerRequest.absoluteURI.

Returns:String

Doc from io.vertx.core.spi.observability.HttpRequest.absoluteURI.

the request absolute URI

Annotations

@Override

authority back to summary

authority	back to summary
public @Nullable HostAndPort authority() Implements io.vertx.core.http.HttpServerRequest.authority. Returns:@Nullable HostAndPort Doc from io.vertx.core.http.HttpServerRequest.authority. the request authority. For HTTP/2 the :authority pseudo header is returned, for HTTP/1.x the Host header is returned or `null` when no such header is present. When the authority string does not carry a port, the `HostAndPort#port()` returns `-1` to indicate the scheme port is prevalent. Annotations @Override

public @Nullable HostAndPort authority()

Implements io.vertx.core.http.HttpServerRequest.authority.

Returns:@Nullable HostAndPort

Doc from io.vertx.core.http.HttpServerRequest.authority.

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

Annotations

@Override

body	back to summary
public synchronized Future<Buffer> body() Implements io.vertx.core.http.HttpServerRequest.body. Doc from io.vertx.core.http.HttpServerRequest.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:Future<Buffer> a future completed with the body result Annotations @Override

body

back to summary

public synchronized Future<Buffer> body()

Implements io.vertx.core.http.HttpServerRequest.body.

Doc from io.vertx.core.http.HttpServerRequest.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:Future<Buffer>

a future completed with the body result

Annotations

@Override

bytesRead	back to summary
public long bytesRead() Implements io.vertx.core.http.HttpServerRequest.bytesRead. Returns:long Doc from io.vertx.core.http.HttpServerRequest.bytesRead. the total number of bytes read for the body of the request. Annotations @Override

bytesRead

back to summary

public long bytesRead()

Implements io.vertx.core.http.HttpServerRequest.bytesRead.

Returns:long

Doc from io.vertx.core.http.HttpServerRequest.bytesRead.

the total number of bytes read for the body of the request.

Annotations

@Override

checkEnded	back to summary
private void checkEnded()

connection back to summary

connection	back to summary
public HttpConnection connection() Implements io.vertx.core.http.HttpServerRequest.connection. Returns:HttpConnection Doc from io.vertx.core.http.HttpServerRequest.connection. the `HttpConnection` associated with this request Annotations @Override

public HttpConnection connection()

Implements io.vertx.core.http.HttpServerRequest.connection.

Returns:HttpConnection

Doc from io.vertx.core.http.HttpServerRequest.connection.

the HttpConnection associated with this request

Annotations

@Override

context	back to summary
public Context context() Implements abstract io.vertx.core.http.impl.HttpServerRequestInternal.context. Returns:Context Doc from io.vertx.core.http.impl.HttpServerRequestInternal.context. the Vert.x context associated with this server request Annotations @Override

context

back to summary

public Context context()

Implements abstract io.vertx.core.http.impl.HttpServerRequestInternal.context.

Returns:Context

Doc from io.vertx.core.http.impl.HttpServerRequestInternal.context.

the Vert.x context associated with this server request

Annotations

@Override

cookies back to summary

public Set<Cookie> cookies()

Implements io.vertx.core.http.HttpServerRequest.cookies.

Doc from io.vertx.core.http.HttpServerRequest.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 <name, domain, path> 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:Set<Cookie>

a set with all cookies in the cookie jar.

Annotations

@Override

cookies back to summary

public Set<Cookie> cookies(String name)

Implements io.vertx.core.http.HttpServerRequest.cookies.

Doc from io.vertx.core.http.HttpServerRequest.cookies.

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 <name, domain, path> 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 Set is read-only. This means any attempt to modify (add or remove to the set), will throw UnsupportedOperationException.

Parameters

name:String: the name to be matches

Returns:Set<Cookie>

the matching cookies or empty set

Annotations

@Override

customFrameHandler	back to summary
public HttpServerRequest customFrameHandler(Handler<HttpFrame> handler) Implements io.vertx.core.http.HttpServerRequest.customFrameHandler. Doc from io.vertx.core.http.HttpServerRequest.customFrameHandler. 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. Returns:HttpServerRequest a reference to this, so the API can be used fluently Annotations @Override

customFrameHandler

back to summary

public HttpServerRequest customFrameHandler(Handler<HttpFrame> handler)

Implements io.vertx.core.http.HttpServerRequest.customFrameHandler.

Doc from io.vertx.core.http.HttpServerRequest.customFrameHandler.

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.

Returns:HttpServerRequest

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

Annotations

@Override

decoderResult back to summary

decoderResult	back to summary
public DecoderResult decoderResult() Implements io.vertx.core.http.HttpServerRequest.decoderResult. Returns:DecoderResult Doc from io.vertx.core.http.HttpServerRequest.decoderResult. Netty's decoder result useful for handling invalid requests with `HttpServer#invalidRequestHandler` Annotations @Override

public DecoderResult decoderResult()

Implements io.vertx.core.http.HttpServerRequest.decoderResult.

Returns:DecoderResult

Doc from io.vertx.core.http.HttpServerRequest.decoderResult.

Netty's decoder result useful for handling invalid requests with HttpServer#invalidRequestHandler

Annotations

@Override

dispatch	back to summary
public void dispatch(Handler<HttpServerRequest> handler) Implements io.vertx.core.http.impl.Http2ServerStreamHandler.dispatch.

end	back to summary
public synchronized Future<Void> end() Implements io.vertx.core.http.HttpServerRequest.end. Doc from io.vertx.core.http.HttpServerRequest.end. Returns a future signaling when the request has been fully received successfully or failed. Returns:Future<Void> a future completed with the body result Annotations @Override

end

back to summary

public synchronized Future<Void> end()

Implements io.vertx.core.http.HttpServerRequest.end.

Doc from io.vertx.core.http.HttpServerRequest.end.

Returns a future signaling when the request has been fully received successfully or failed.

Returns:Future<Void>

a future completed with the body result

Annotations

@Override

endHandler	back to summary
public HttpServerRequest endHandler(Handler<Void> handler) Implements io.vertx.core.http.HttpServerRequest.endHandler. Annotations @Override

endHandler

back to summary

public HttpServerRequest endHandler(Handler<Void> handler)

Implements io.vertx.core.http.HttpServerRequest.endHandler.

Annotations

@Override

eventHandler	back to summary
private HttpEventHandler eventHandler(boolean create)

exceptionHandler	back to summary
public HttpServerRequest exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.http.HttpServerRequest.exceptionHandler. Annotations @Override

exceptionHandler

back to summary

public HttpServerRequest exceptionHandler(Handler<Throwable> handler)

Implements io.vertx.core.http.HttpServerRequest.exceptionHandler.

Annotations

@Override

fetch back to summary

fetch	back to summary
public HttpServerRequest fetch(long amount) Implements io.vertx.core.http.HttpServerRequest.fetch. Doc from io.vertx.core.streams.ReadStream.fetch. 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. Returns:HttpServerRequest a reference to this, so the API can be used fluently Annotations @Override

public HttpServerRequest fetch(long amount)

Implements io.vertx.core.http.HttpServerRequest.fetch.

Doc from io.vertx.core.streams.ReadStream.fetch.

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.

Returns:HttpServerRequest

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

Annotations

@Override

formAttributes back to summary

formAttributes	back to summary
public MultiMap formAttributes() Implements io.vertx.core.http.HttpServerRequest.formAttributes. Doc from io.vertx.core.http.HttpServerRequest.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:MultiMap the form attributes Annotations @Override

public MultiMap formAttributes()

Implements io.vertx.core.http.HttpServerRequest.formAttributes.

Doc from io.vertx.core.http.HttpServerRequest.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:MultiMap

the form attributes

Annotations

@Override

getCookie back to summary

public Cookie getCookie(String name)

Implements io.vertx.core.http.HttpServerRequest.getCookie.

Doc from io.vertx.core.http.HttpServerRequest.getCookie.

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(String)

Parameters

name:String: the cookie name

Returns:Cookie

the cookie or null if not found.

Annotations

@Override

getCookie back to summary

public Cookie getCookie(String name, String domain, String path)

Implements io.vertx.core.http.HttpServerRequest.getCookie.

Doc from io.vertx.core.http.HttpServerRequest.getCookie.

Get the cookie with the specified <name, domain, path>.

Parameters

name:String: the cookie name
domain:String: the cookie domain
path:String: the cookie path

Returns:Cookie

the cookie or null if not found.

Annotations

@Override

getFormAttribute	back to summary
public String getFormAttribute(String attributeName) Implements io.vertx.core.http.HttpServerRequest.getFormAttribute. Doc from io.vertx.core.http.HttpServerRequest.getFormAttribute. Return the first form attribute value with the specified name Parameters attributeName:String the attribute name Returns:String the attribute value Annotations @Override

getFormAttribute

back to summary

public String getFormAttribute(String attributeName)

Implements io.vertx.core.http.HttpServerRequest.getFormAttribute.

Doc from io.vertx.core.http.HttpServerRequest.getFormAttribute.

Return the first form attribute value with the specified name

Parameters

attributeName:String: the attribute name

Returns:String

the attribute value

Annotations

@Override

getParamsCharset	back to summary
public String getParamsCharset() Implements io.vertx.core.http.HttpServerRequest.getParamsCharset. Returns:String Doc from io.vertx.core.http.HttpServerRequest.getParamsCharset. the charset used for decoding query parameters Annotations @Override

getParamsCharset

back to summary

public String getParamsCharset()

Implements io.vertx.core.http.HttpServerRequest.getParamsCharset.

Returns:String

Doc from io.vertx.core.http.HttpServerRequest.getParamsCharset.

the charset used for decoding query parameters

Annotations

@Override

handleClose	back to summary
public void handleClose() Implements io.vertx.core.http.impl.Http2ServerStreamHandler.handleClose. Annotations @Override

handleClose

back to summary

public void handleClose()

Implements io.vertx.core.http.impl.Http2ServerStreamHandler.handleClose.

Annotations

@Override

handleCustomFrame	back to summary
public void handleCustomFrame(HttpFrame frame) Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handleCustomFrame. Annotations @Override

handleCustomFrame

back to summary

public void handleCustomFrame(HttpFrame frame)

Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handleCustomFrame.

Annotations

@Override

handleData	back to summary
public void handleData(Buffer data) Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handleData. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

handleEnd	back to summary
public void handleEnd(MultiMap trailers) Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handleEnd.

handleException	back to summary
public void handleException(Throwable cause) Implements io.vertx.core.http.impl.Http2ServerStreamHandler.handleException. Annotations @Override

handleException

back to summary

public void handleException(Throwable cause)

Implements io.vertx.core.http.impl.Http2ServerStreamHandler.handleException.

Annotations

@Override

handlePriorityChange	back to summary
public void handlePriorityChange(StreamPriority streamPriority) Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handlePriorityChange. Annotations @Override

handlePriorityChange

back to summary

public void handlePriorityChange(StreamPriority streamPriority)

Overrides default io.vertx.core.http.impl.Http2ServerStreamHandler.handlePriorityChange.

Annotations

@Override

handler

back to summary

public HttpServerRequest handler(Handler<Buffer> handler)

Implements io.vertx.core.http.HttpServerRequest.handler.

Annotations

@Override

handleReset

back to summary

public void handleReset(long errorCode)

Implements io.vertx.core.http.impl.Http2ServerStreamHandler.handleReset.

Annotations

@Override

headers

back to summary

public MultiMap headers()

Implements io.vertx.core.spi.observability.HttpRequest.headers, io.vertx.core.http.HttpServerRequest.headers.

Returns:MultiMap

Doc from io.vertx.core.spi.observability.HttpRequest.headers.

the request headers

Annotations

@Override

host

back to summary

public String host()

Implements io.vertx.core.http.HttpServerRequest.host.

Returns:String

Doc from io.vertx.core.http.HttpServerRequest.host.

the request host. For HTTP2 it returns the :authority pseudo header otherwise it returns the Host header

Annotations

@Override

back to summary

public int id()

Implements io.vertx.core.spi.observability.HttpRequest.id.

Returns:int

Doc from io.vertx.core.spi.observability.HttpRequest.id.

the stream id

Annotations

@Override

isEnded

back to summary

public boolean isEnded()

Implements io.vertx.core.http.HttpServerRequest.isEnded.

Doc from io.vertx.core.http.HttpServerRequest.isEnded.

Has the request ended? I.e. has the entire request, including the body been read?

Returns:boolean

true if ended

Annotations

@Override

isExpectMultipart back to summary

public boolean isExpectMultipart()

Implements io.vertx.core.http.HttpServerRequest.isExpectMultipart.

Returns:boolean

Doc from io.vertx.core.http.HttpServerRequest.isExpectMultipart.

true if we are expecting a multi-part body for this request. See setExpectMultipart.

Annotations

@Override

method

back to summary

public HttpMethod method()

Implements io.vertx.core.spi.observability.HttpRequest.method, io.vertx.core.http.HttpServerRequest.method.

Returns:HttpMethod

Doc from io.vertx.core.spi.observability.HttpRequest.method.

the request method

Annotations

@Override

metric back to summary

public Object metric()

Implements abstract io.vertx.core.http.impl.HttpServerRequestInternal.metric.

Returns:Object

Doc from io.vertx.core.http.impl.HttpServerRequestInternal.metric.

the metric object returned by the io.vertx.core.spi.metrics.HttpServerMetrics#requestBegin(Object, HttpRequest) call

Annotations

@Override

notifyException	back to summary
private void notifyException(Throwable failure)

params

back to summary

public MultiMap params(boolean semicolonIsNormalChar)

Implements io.vertx.core.http.HttpServerRequest.params.

Parameters

semicolonIsNormalChar:boolean

Doc from io.vertx.core.http.HttpServerRequest.params.

whether semicolon is treated as a normal character or a query parameter separator

Returns:MultiMap

Doc from io.vertx.core.http.HttpServerRequest.params.

the query parameters in the request

Annotations

@Override

path

back to summary

public String path()

Implements io.vertx.core.http.HttpServerRequest.path.

Returns:String

Doc from io.vertx.core.http.HttpServerRequest.path.

The path part of the uri. For example /somepath/somemorepath/someresource.foo

Annotations

@Override

pause back to summary

public HttpServerRequest pause()

Implements io.vertx.core.http.HttpServerRequest.pause.

Doc from io.vertx.core.streams.ReadStream.pause.

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.

Returns:HttpServerRequest

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

Annotations

@Override

peerCertificateChain back to summary

public X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException

Implements io.vertx.core.http.HttpServerRequest.peerCertificateChain.

Doc from io.vertx.core.http.HttpServerRequest.peerCertificateChain.

References Deprecated

X509Certificate is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Note

Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on. Use sslSession() to access that method.

Returns:X509Certificate[]

an ordered array of the peer certificates. Returns null if connection is not SSL.

Annotations

@Override

Exceptions

SSLPeerUnverifiedException:: SSL peer's identity has not been verified.

query

back to summary

public String query()

Implements io.vertx.core.http.HttpServerRequest.query.

Returns:String

Doc from io.vertx.core.http.HttpServerRequest.query.

the query part of the uri. For example someparam=32&someotherparam=x

Annotations

@Override

remoteAddress

back to summary

public SocketAddress remoteAddress()

Overrides default io.vertx.core.http.HttpServerRequest.remoteAddress.

Implements io.vertx.core.spi.observability.HttpRequest.remoteAddress.

Returns:SocketAddress

Doc from io.vertx.core.spi.observability.HttpRequest.remoteAddress.

the request remote peer address

Annotations

@Override

response back to summary

public Http2ServerResponse response()

Implements io.vertx.core.http.impl.Http2ServerStreamHandler.response, io.vertx.core.http.HttpServerRequest.response.

Returns:Http2ServerResponse

Doc from io.vertx.core.http.HttpServerRequest.response.

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.

Annotations

@Override

resume back to summary

public HttpServerRequest resume()

Implements io.vertx.core.http.HttpServerRequest.resume.

Doc from io.vertx.core.streams.ReadStream.resume.

Resume reading, and sets the buffer in flowing mode.

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

Returns:HttpServerRequest

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

Annotations

@Override

routed

back to summary

public HttpServerRequest routed(String route)

Overrides default io.vertx.core.http.HttpServerRequest.routed.

Doc from io.vertx.core.http.HttpServerRequest.routed.

Marks this request as being routed to the given route. This is purely informational and is being provided to metrics.

Parameters

route:String: The route this request has been routed to.

Annotations

@Override

scheme

back to summary

public String scheme()

Implements io.vertx.core.http.HttpServerRequest.scheme.

Returns:String

Doc from io.vertx.core.http.HttpServerRequest.scheme.

the scheme of the request

Annotations

@Override

setExpectMultipart

back to summary

public HttpServerRequest setExpectMultipart(boolean expect)

Implements io.vertx.core.http.HttpServerRequest.setExpectMultipart.

Doc from io.vertx.core.http.HttpServerRequest.setExpectMultipart.

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