Method Detail

• <T> public T get(java.lang.String key)

  Shortcut for HttpServerRequest#getState().get(String)

  Parameters:

  key - The state item.

  Type Parameters:

  T - The return type.

  Returns:

  An item from the request state, or null if it is not found.

• <T> public T getAt(java.lang.String key)

  Facilitates the use of Groovy's subscript operator ([]).

  See Also:

  HttpServerRequest.get

  Parameters:

  key - The state item.

  Type Parameters:

  T - The return type.

  Returns:

  An item from the request state, or null if it is not found.

• public HttpServerRequest.Body getBody()

  Returns:

  The request body.

• public java.lang.String getContentType()

  Returns:

  The value of the Content-Type header.

• public java.util.Map<java.lang.String, java.lang.String> getCookies()

  RFC States that there can be multiple cookies with the same name, but seeing that this is a practice we try to discourage internally, this pattern will go a long way in enforcing that. Name your cookies uniquely! The Map will contain the cookie name and its value.

  Returns:

  A Map of Cookies and their values.

• public java.util.Set<io.vertx.ext.web.FileUpload> getFileUploads()

  Returns:

  The files sent with this request.

• public io.vertx.core.MultiMap getHeaders()

• public java.lang.String getHost()

• public java.lang.String getMethod()

  Returns:

  The HTTP method used for this request.

• public java.lang.String getPath()

  Returns:

  The path portion of the URI e.g. /customers

• public java.lang.String getPathParam(java.lang.String name)

  Parameters:

  name - The name of the parameter.

  Returns:

  The named parameter from the path e.g. /users/:id

• public java.util.Map<java.lang.String, java.lang.String> getPathParams()

  Returns:

  A Map of path parameters.

• public io.vertx.core.MultiMap getQueryParams()

  Returns:

  The query parameters in the URL.

• public java.util.Map<java.lang.String, java.lang.Object> getState()

• public java.net.URI getUri()

• public void next()

  Pass the request on to the next matching route. Useful for filters.

• public HttpServerRequest put(java.lang.String key, java.lang.Object value)

  Add an arbitrary item to the request state.

  Parameters:

  key - The key.

  value - The value.

  Returns:

  This instance.

• public void putAt(java.lang.String key, java.lang.Object value)

  Facilitates the use of Groovy's subscript operator ([]).

  See Also:

  HttpServerRequest.put

  Parameters:

  key - The key.

  value - The value.

• public HttpServerRequest remove(java.lang.String key)

  Remove an item from the request's state.

  Parameters:

  key - The item key.

  Returns:

  This instance.

• public io.vertx.core.http.HttpServerRequest unwrap()

  If you find yourself using this method, document your use case and create a pull request.

  Returns:

  The underlying Vertx Web HttpServerRequest.

  See Also:

  HttpServerRequest