vertx-lang-scala-docs_2.12 3.4.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package web
  Definition Classes
    ext
-  package client
  Definition Classes
    web
-  package codec
  Definition Classes
    web
-  package handler
  Definition Classes
    web
-  package sockjs
- AuthHandler
- BasicAuthHandler
- BodyHandler
- CSRFHandler
- CookieHandler
- CorsHandler
- DigestAuthHandler
- ErrorHandler
- FaviconHandler
- FormLoginHandler
- JWTAuthHandler
- LoggerHandler
- OAuth2AuthHandler
- RedirectAuthHandler
- ResponseContentTypeHandler
- ResponseTimeHandler
- SessionHandler
- StaticHandler
- TemplateHandler
- TimeoutHandler
- UserSessionHandler
- VirtualHostHandler
-  package sstore
  Definition Classes
    web
-  package templ
  Definition Classes
    web

p

io.vertx.scala.ext.web

# handler 

#### package handler

 
Ordering

1. Alphabetic

Visibility

1. Public
2. All

### Type Members

1.  trait AuthHandler extends Handler[RoutingContext]

   Base interface for auth handlers.

   Base interface for auth handlers.

   An auth handler allows your application to provide authentication/authorisation support.

   Auth handler requires a io.vertx.scala.ext.web.handler.SessionHandler to be on the routing chain before it.

2.  class BasicAuthHandler extends AuthHandler

   An auth handler that provides HTTP Basic Authentication support.

3.  class BodyHandler extends Handler[RoutingContext]

   A handler which gathers the entire request body and sets it on the .

   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.

4.  class CSRFHandler extends Handler[RoutingContext]

   This handler adds a CSRF token to requests which mutate state.

   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.

5.  class CookieHandler extends Handler[RoutingContext]

   A handler which decodes cookies from the request, makes them available in the and writes them back in the response.

6.  class CorsHandler extends Handler[RoutingContext]

   A handler which implements server side http://www.w3.org/TR/cors/[CORS] support for Vert.x-Web.

7.  class DigestAuthHandler extends AuthHandler

   An auth handler that provides HTTP Basic Authentication support.

8.  class ErrorHandler extends Handler[RoutingContext]

   A pretty error handler for rendering error pages.

9.  class FaviconHandler extends Handler[RoutingContext]

   A handler that serves favicons.

   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.

10.  class FormLoginHandler extends Handler[RoutingContext]

    Handler that handles login from a form on a custom login page.

    Handler that handles login from a form on a custom login page.

    Used in conjunction with the io.vertx.scala.ext.web.handler.RedirectAuthHandler.

11.  class JWTAuthHandler extends AuthHandler

    An auth handler that provides JWT Authentication support.

12.  class LoggerHandler extends Handler[RoutingContext]

    A handler which logs request information to the Vert.x logger.

13.  class OAuth2AuthHandler extends AuthHandler

    An auth handler that provides OAuth2 Authentication support.

    An auth handler that provides OAuth2 Authentication support. This handler is suitable for AuthCode flows.

14.  class RedirectAuthHandler extends AuthHandler

    An auth handler that's used to handle auth by redirecting user to a custom login page.

15.  class ResponseContentTypeHandler extends Handler[RoutingContext]

    A handler which sets the response content type automatically according to the best `Accept` header match.

    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.scala.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
16.  class ResponseTimeHandler extends 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.

17.  class SessionHandler extends Handler[RoutingContext]

    A handler that maintains a io.vertx.scala.ext.web.Session for each browser session.

    A handler that maintains a io.vertx.scala.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.scala.ext.web.handler.CookieHandler to be on the routing chain before it.

18.  class StaticHandler extends Handler[RoutingContext]

    A handler for serving static resources from the file system or classpath.

19.  class TemplateHandler extends Handler[RoutingContext]

    A handler which renders responses using a template engine and where the template name is selected from the URI path.

20.  class TimeoutHandler extends Handler[RoutingContext]

    Handler that will timeout requests if the response has not been written after a certain time.

    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`.

21.  class UserSessionHandler extends 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.

    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.

22.  class VirtualHostHandler extends Handler[RoutingContext]

    Handler that will filter requests based on the request Host name.

### Value Members

1.  object AuthHandler
2.  object BasicAuthHandler
3.  object BodyHandler
4.  object CSRFHandler
5.  object CookieHandler
6.  object CorsHandler
7.  object DigestAuthHandler
8.  object ErrorHandler
9.  object FaviconHandler
10.  object FormLoginHandler
11.  object JWTAuthHandler
12.  object LoggerHandler
13.  object OAuth2AuthHandler
14.  object RedirectAuthHandler
15.  object ResponseContentTypeHandler
16.  object ResponseTimeHandler
17.  object SessionHandler
18.  object StaticHandler
19.  object TemplateHandler
20.  object TimeoutHandler
21.  object UserSessionHandler
22.  object VirtualHostHandler

### Ungrouped