# Index

`AuthHandler` | Base interface for auth handlers. A
`BasicAuthHandler` | An auth handler that provides HTTP Basic Authentication support.
`BodyHandler` | A handler which gathers the entire request body and sets it on the . I
`BridgeEvent` | Represents an event that occurs on the event bus bridge. P
`BridgeEventType` | Bridge Event Types.
`BridgeOptions` | Options for configuring the event bus bridge.
`CSRFHandler` | This handler adds a CSRF token to requests which mutate state.
`ClusteredSessionStore` | A session store which stores sessions in a distributed map so they are available across the cluster.
`Cookie` | Represents an HTTP Cookie. A
`CookieHandler` | A handler which decodes cookies from the request, makes them available in the and writes them back in the response.
`CorsHandler` | A handler which implements server side http://www.w3.org/TR/cors/[CORS] support for Vert.x-Web.
`DigestAuthHandler` | An auth handler that provides HTTP Basic Authentication support.
`ErrorHandler` | A pretty error handler for rendering error pages.
`FaviconHandler` | A handler that serves favicons. I
`FileUpload` | Represents a file-upload from an HTTP multipart form submission. <
`FormLoginHandler` | Handler that handles login from a form on a custom login page. U
`HandlebarsTemplateEngine` | A template engine that uses the Handlebars library.
`JWTAuthHandler` | An auth handler that provides JWT Authentication support.
`JadeTemplateEngine` | A template engine that uses Jade.
`LanguageHeader` | A parsed language header.
`LocalSessionStore` | A session store which is only available on a single node. C
`Locale` |
`LoggerFormat` | The possible out of the box formats.
`LoggerHandler` | A handler which logs request information to the Vert.x logger.
`MIMEHeader` |
`MVELTemplateEngine` | A template engine that uses the Handlebars library.
`OAuth2AuthHandler` | An auth handler that provides OAuth2 Authentication support.
`ParsedHeaderValue` |
`ParsedHeaderValues` | A container with the request's headers that are meaningful enough to be parsed Contains:
`PermittedOptions` | Specify a match to allow for inbound and outbound traffic using the BridgeOptions.
`RedirectAuthHandler` | An auth handler that's used to handle auth by redirecting user to a custom login page.
`ResponseContentTypeHandler` | A handler which sets the response content type automatically according to the best `Accept` header match.
`ResponseTimeHandler` | Handler which adds a header `x-response-time` in the response of matching requests containing the time taken in ms to…
`Route` | A route is a holder for a set of criteria which determine whether an HTTP request or failure should be routed to a…
`Router` | A router receives request from an `io.vertx.core.http.HttpServer` and routes it to the first matching Route that it…
`RoutingContext` | Represents the context for the handling of a request in Vert.x-Web. A
`Session` | Represents a browser session. S
`SessionHandler` | A handler that maintains a Session for each browser session. I
`SessionStore` | A session store is used to store sessions for an Vert.x-Web web app
`SockJSHandler` | A handler that allows you to handle SockJS connections from clients. W
`SockJSHandlerOptions` | Options for configuring a SockJS handler
`SockJSSocket` | You interact with SockJS clients through instances of SockJS socket. T
`StaticHandler` | A handler for serving static resources from the file system or classpath.
`TemplateEngine` | A template engine uses a specific template and the data in a routing context to render a resource into a buffer. C
`TemplateHandler` | A handler which renders responses using a template engine and where the template name is selected from the URI path.
`ThymeleafTemplateEngine` | A template engine that uses the Thymeleaf library.
`TimeoutHandler` | Handler that will timeout requests if the response has not been written after a certain time. T
`Transport` | The available SockJS transports
`UserSessionHandler` | This handler should be used if you want to store the User object in the Session so it's available between different…
`VirtualHostHandler` | Handler that will filter requests based on the request Host name.
`basicAuthHandler` |
`bodyHandler` |
`bridgeEventType` |
`bridgeOptions` |
`clusteredSessionStore` |
`cookie` |
`cookieHandler` |
`corsHandler` |
`csrfHandler` |
`default` | remote-client - - [timestamp] “method uri version” status content-length “referrer” “user-agent”
`digestAuthHandler` |
`errorHandler` |
`event_source` | Event source
`faviconHandler` |
`formLoginHandler` |
`handlebarsTemplateEngine` |
`html_file` | HtmlFile.
`jadeTemplateEngine` |
`json_p` | Slow and old fashioned JSONP polling.
`jwtAuthHandler` |
`localSessionStore` |
`locale` |
`loggerFormat` |
`loggerHandler` |
`mvelTemplateEngine` |
`oAuth2AuthHandler` |
`permittedOptions` |
`publish` | This event will occur when a message is attempted to be published from the client to the server.
`receive` | This event will occur when a message is attempted to be delivered from the server to the client.
`redirectAuthHandler` |
`register` | This event will occur when a client attempts to register a handler.
`responseContentTypeHandler` |
`responseTimeHandler` |
`router` |
`send` | This event will occur when a message is attempted to be sent from the client to the server.
`sessionHandler` |
`short` | remote-client - method uri version status content-length duration ms
`sockJSHandler` |
`sockJSHandlerOptions` |
`socket_closed` | This event will occur when a SockJS socket is closed.
`socket_created` | This event will occur when a new SockJS socket is created.
`socket_idle` | This event will occur when SockJS socket is on idle for longer period of time than configured.
`socket_ping` | This event will occur when the last ping timestamp is updated for the SockJS socket.
`staticHandler` |
`templateHandler` |
`thymeleafTemplateEngine` |
`timeoutHandler` |
`tiny` | method uri status - content-length duration
`transport` |
`unregister` | This event will occur when a client attempts to unregister a handler.
`userSessionHandler` |
`virtualHostHandler` |
`websocket` | rfc 6455
`xhr` | Long-polling using cross domain XHR