vertx / io.vertx.rxjava.ext.web.handler

## Package io.vertx.rxjava.ext.web.handler

### Types

AuthHandler | `interface AuthHandler : Handler<RoutingContext>` Base interface for auth handlers. An auth handler allows your application to provide authentication/authorisation support. Auth handler requires a io.vertx.rxjava.ext.web.handler.SessionHandler to be on the routing chain before it. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.AuthHandler non RX-ified interface using Vert.x codegen.
BasicAuthHandler | `open class BasicAuthHandler : AuthHandler, Handler<RoutingContext>` An auth handler that provides HTTP Basic Authentication support. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.BasicAuthHandler non RX-ified interface using Vert.x codegen.
BodyHandler | `open class BodyHandler : Handler<RoutingContext>` A handler which gathers the entire request body and sets it on the . It also handles HTTP file uploads and can be used to limit body sizes. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.BodyHandler non RX-ified interface using Vert.x codegen.
CSRFHandler | `open class 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. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.CSRFHandler non RX-ified interface using Vert.x codegen.
ChainAuthHandler | `open class ChainAuthHandler : AuthHandler, Handler<RoutingContext>` An auth handler that chains to a sequence of handlers. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.ChainAuthHandler non RX-ified interface using Vert.x codegen.
CookieHandler | `open class CookieHandler : Handler<RoutingContext>` A handler which decodes cookies from the request, makes them available in the and writes them back in the response. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.CookieHandler non RX-ified interface using Vert.x codegen.
CorsHandler | `open class CorsHandler : Handler<RoutingContext>` A handler which implements server side http://www.w3.org/TR/cors/[CORS] support for Vert.x-Web. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.CorsHandler non RX-ified interface using Vert.x codegen.
DigestAuthHandler | `open class DigestAuthHandler : AuthHandler, Handler<RoutingContext>` An auth handler that provides HTTP Basic Authentication support. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.DigestAuthHandler non RX-ified interface using Vert.x codegen.
ErrorHandler | `open class ErrorHandler : Handler<RoutingContext>` A pretty error handler for rendering error pages. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.ErrorHandler non RX-ified interface using Vert.x codegen.
FaviconHandler | `open class 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. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.FaviconHandler non RX-ified interface using Vert.x codegen.
FormLoginHandler | `open class FormLoginHandler : Handler<RoutingContext>` Handler that handles login from a form on a custom login page. Used in conjunction with the io.vertx.rxjava.ext.web.handler.RedirectAuthHandler. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.FormLoginHandler non RX-ified interface using Vert.x codegen.
JWTAuthHandler | `open class JWTAuthHandler : AuthHandler, Handler<RoutingContext>` An auth handler that provides JWT Authentication support. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.JWTAuthHandler non RX-ified interface using Vert.x codegen.
LoggerHandler | `open class LoggerHandler : Handler<RoutingContext>` A handler which logs request information to the Vert.x logger. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.LoggerHandler non RX-ified interface using Vert.x codegen.
OAuth2AuthHandler | `open class OAuth2AuthHandler : AuthHandler, Handler<RoutingContext>` An auth handler that provides OAuth2 Authentication support. This handler is suitable for AuthCode flows. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.OAuth2AuthHandler non RX-ified interface using Vert.x codegen.
RedirectAuthHandler | `open class RedirectAuthHandler : AuthHandler, Handler<RoutingContext>` An auth handler that's used to handle auth by redirecting user to a custom login page. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.RedirectAuthHandler non RX-ified interface using Vert.x codegen.
ResponseContentTypeHandler | `open class ResponseContentTypeHandler : Handler<RoutingContext>` A handler which sets the response content type automatically according to the best `Accept` header match. The header is set only if: no object is stored in the routing context under the name io.vertx.rxjava.ext.web.handler.ResponseContentTypeHandler a match is found the header is not present already content length header is absent or set to something different than zero NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.ResponseContentTypeHandler non RX-ified interface using Vert.x codegen.
ResponseTimeHandler | `open class 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. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.ResponseTimeHandler non RX-ified interface using Vert.x codegen.
SessionHandler | `open class SessionHandler : Handler<RoutingContext>` A handler that maintains a io.vertx.rxjava.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 io.vertx.rxjava.ext.web.handler.CookieHandler to be on the routing chain before it. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.SessionHandler non RX-ified interface using Vert.x codegen.
StaticHandler | `open class StaticHandler : Handler<RoutingContext>` A handler for serving static resources from the file system or classpath. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.StaticHandler non RX-ified interface using Vert.x codegen.
TemplateHandler | `open class TemplateHandler : Handler<RoutingContext>` A handler which renders responses using a template engine and where the template name is selected from the URI path. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.TemplateHandler non RX-ified interface using Vert.x codegen.
TimeoutHandler | `open class 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`. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.TimeoutHandler non RX-ified interface using Vert.x codegen.
UserSessionHandler | `open class 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. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.UserSessionHandler non RX-ified interface using Vert.x codegen.
VirtualHostHandler | `open class VirtualHostHandler : Handler<RoutingContext>` Handler that will filter requests based on the request Host name. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.VirtualHostHandler non RX-ified interface using Vert.x codegen.