Platform: Java
Packages
io.vertx.ceylon.web
io.vertx.ceylon.web.handler
io.vertx.ceylon.web.handler.sockjs
io.vertx.ceylon.web.sstore
io.vertx.ceylon.web.templ
Dependencies
ceylon.json1.3.0
io.vertx.ceylon.auth.htdigest3.4.1
io.vertx.ceylon.auth.jwt3.4.1
io.vertx.ceylon.auth.oauth23.4.1
io.vertx.ceylon.core3.4.1
io.vertx.vertx-web3.4.1
io.vertx.vertx-web-templ-freemarker3.4.1
io.vertx.vertx-web-templ-handlebars3.4.1
io.vertx.vertx-web-templ-jade3.4.1
io.vertx.vertx-web-templ-mvel3.4.1
io.vertx.vertx-web-templ-pebble3.4.1
io.vertx.vertx-web-templ-thymeleaf3.4.1
java.base (jvm)8
Values
shared cookie cookie
localeshared locale locale
routershared router router
Interfaces
ParsedHeaderValueshared ParsedHeaderValue
Classes
shared Cookie

Represents an HTTP Cookie.

All cookies must have a name and a value and can optionally have other fields set such as path, domain, etc.

(Derived from io.netty.handler.codec.http.Cookie)

FileUploadshared FileUpload

Represents a file-upload from an HTTP multipart form submission.

LanguageHeadershared LanguageHeader

A parsed language header. Delivers a more direct access to the individual elements of the header it represents

Localeshared Locale
MIMEHeadershared MIMEHeader
ParsedHeaderValuesshared ParsedHeaderValues

A container with the request's headers that are meaningful enough to be parsed Contains:

  • Accept -> MIME header, parameters and sortable
  • Accept-Charset -> Parameters and sortable
  • Accept-Encoding -> Parameters and sortable
  • Accept-Language -> Parameters and sortable
  • Content-Type -> MIME header and parameters
Routeshared Route

A route is a holder for a set of criteria which determine whether an HTTP request or failure should be routed to a handler.

Routershared Router

A router receives request from an io.vertx.core.http.HttpServer and routes it to the first matching Route that it contains. A router can contain many routes.

Routers are also used for routing failures.

RoutingContextshared RoutingContext

Represents the context for the handling of a request in Vert.x-Web.

A new instance is created for each HTTP request that is received in the accept of the router.

The same instance is passed to any matching request or failure handlers during the routing of the request or failure.

The context provides access to the and and allows you to maintain arbitrary data that lives for the lifetime of the context. Contexts are discarded once they have been routed to the handler for the request.

The context also provides access to the Session, cookies and body for the request, given the correct handlers in the application.

Sessionshared Session

Represents a browser session.

Sessions persist between HTTP requests for a single browser session. They are deleted when the browser is closed, or they time-out. Session cookies are used to maintain sessions using a secure UUID.

Sessions can be used to maintain data for a browser session, e.g. a shopping basket.

The context must have first been routed to a SessionHandler for sessions to be available.

shared cookie
localeshared locale
routershared router