interface AuthHandler : Handler<RoutingContext>
Base interface for auth handlers. An auth handler allows your application to provide authentication/authorisation support. Auth handler requires a SessionHandler to be on the routing chain before it. |
|
interface BasicAuthHandler : AuthHandler
An auth handler that provides HTTP Basic Authentication support. |
|
interface BodyHandler : Handler<RoutingContext>
A handler which gathers the entire request body and sets it on the RoutingContext. It also handles HTTP file uploads and can be used to limit body sizes. |
|
interface CSRFHandler : Handler<RoutingContext>
This handler adds a CSRF token to requests which mutate state. In order change the state a (XSRF-TOKEN) cookie is set with a unique token, that is expected to be sent back in a (X-XSRF-TOKEN) header. The behavior is to check the request body header and cookie for validity. This Handler requires session support, thus should be added somewhere below Session and Body handlers. |
|
interface ChainAuthHandler : AuthHandler
An auth handler that chains to a sequence of handlers. |
|
interface CookieHandler : Handler<RoutingContext>
A handler which decodes cookies from the request, makes them available in the RoutingContext and writes them back in the response. |
|
interface CorsHandler : Handler<RoutingContext>
A handler which implements server side http://www.w3.org/TR/cors/[CORS] support for Vert.x-Web. |
|
interface DigestAuthHandler : AuthHandler
An auth handler that provides HTTP Basic Authentication support. |
|
interface ErrorHandler : Handler<RoutingContext>
A pretty error handler for rendering error pages. |
|
interface FaviconHandler : Handler<RoutingContext>
A handler that serves favicons. If no file system path is specified it will attempt to serve a resource called `favicon.ico` from the classpath. |
|
interface FormLoginHandler : Handler<RoutingContext>
Handler that handles login from a form on a custom login page. Used in conjunction with the RedirectAuthHandler. |
|
interface JWTAuthHandler : AuthHandler
An auth handler that provides JWT Authentication support. |
|
class LoggerFormat
The possible out of the box formats. |
|
interface LoggerHandler : Handler<RoutingContext>
A handler which logs request information to the Vert.x logger. |
|
interface OAuth2AuthHandler : AuthHandler
An auth handler that provides OAuth2 Authentication support. This handler is suitable for AuthCode flows. |
|
interface RedirectAuthHandler : AuthHandler
An auth handler that's used to handle auth by redirecting user to a custom login page. |
|
interface ResponseContentTypeHandler : Handler<RoutingContext>
A handler which sets the response content type automatically according to the best
|
|
interface ResponseTimeHandler : Handler<RoutingContext>
Handler which adds a header `x-response-time` in the response of matching requests containing the time taken in ms to process the request. |
|
interface SessionHandler : Handler<RoutingContext>
A handler that maintains a io.vertx.ext.web.Session for each browser session. It looks up the session for each request based on a session cookie which contains a session ID. It stores the session when the response is ended in the session store. The session is available on the routing context with The session handler requires a CookieHandler to be on the routing chain before it. |
|
interface StaticHandler : Handler<RoutingContext>
A handler for serving static resources from the file system or classpath. |
|
interface TemplateHandler : Handler<RoutingContext>
A handler which renders responses using a template engine and where the template name is selected from the URI path. |
|
interface TimeoutHandler : Handler<RoutingContext>
Handler that will timeout requests if the response has not been written after a certain time. Timeout requests will be ended with an HTTP status code `503`. |
|
interface UserSessionHandler : Handler<RoutingContext>
This handler should be used if you want to store the User object in the Session so it's available between different requests, without you having re-authenticate each time. It requires that the session handler is already present on previous matching routes. It requires an Auth provider so, if the user is deserialized from a clustered session it knows which Auth provider to associate the session with. |
|
interface VirtualHostHandler : Handler<RoutingContext>
Handler that will filter requests based on the request Host name. |