Classes, interfaces and traits

AuthHandler

Base interface for auth handlers.

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

Auth handler requires a @see \io\vertx\jphp\ext\web\handler\SessionHandler to be on the routing chain before it.

« More »

BasicAuthHandler

An auth handler that provides HTTP Basic Authentication support.

« More »

BodyHandler

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.

« More »

ChainAuthHandler

An auth handler that chains to a sequence of handlers.

« More »

CookieHandler

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

« More »

CorsHandler

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

« More »

CSRFHandler

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.

« More »

DigestAuthHandler

An auth handler that provides HTTP Basic Authentication support.

« More »

ErrorHandler

A pretty error handler for rendering error pages. When working in development mode exception details will be returned in the server responses, otherwise or when manually specified no exception details are returned in the HTTP response.

The reason the display of the exception details is by default dependent of the mode is to follow the security best practices: https://www.owasp.org/index.php/Improper_Error_Handling

« More »

FaviconHandler

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.

« More »

FormLoginHandler

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

Used in conjunction with the @see \io\vertx\jphp\ext\web\handler\RedirectAuthHandler.

« More »

JWTAuthHandler

An auth handler that provides JWT Authentication support.

« More »

LoggerHandler

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

« More »

OAuth2AuthHandler

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

« More »

RedirectAuthHandler

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

« More »

ResponseContentTypeHandler

A handler which sets the response content type automatically according to the best <code>Accept</code> header match.

The header is set only if:

  • no object is stored in the routing context under the name @see \io\vertx\jphp\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
« More »

ResponseTimeHandler

Handler which adds a header `x-response-time` in the response of matching requests containing the time taken in ms to process the request.

« More »

SessionHandler

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

« More »

StaticHandler

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

« More »

TemplateHandler

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

« More »

TimeoutHandler

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.

« More »

UserSessionHandler

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.

« More »

VirtualHostHandler

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

« More »

Classes, interfaces and traits

BridgeEvent

Represents an event that occurs on the event bus bridge.

Please consult the documentation for a full explanation.

« More »

BridgeOptions

Options for configuring the event bus bridge.

« More »

PermittedOptions

Specify a match to allow for inbound and outbound traffic using the

« More »

SockJSHandler

A handler that allows you to handle SockJS connections from clients.

We currently support version 0.3.3 of the SockJS protocol, which can be found in this tag:

« More »

SockJSHandlerOptions

Options for configuring a SockJS handler

« More »

SockJSSocket

You interact with SockJS clients through instances of SockJS socket.

The API is very similar to @see \io\vertx\jphp\core\http\WebSocket. It implements both and so it can be used with

« More »