A B C D E F G H I J L M N O P Q R S T U V W X
All Classes All Packages

A

AbstractSession - Class in io.vertx.ext.web.sstore

The abstract session class provides a barebones implementation for session storage implementors.

AbstractSession() - Constructor for class io.vertx.ext.web.sstore.AbstractSession

This constructor is mandatory (even though not referenced anywhere) is required for serialization purposes.

AbstractSession(VertxContextPRNG) - Constructor for class io.vertx.ext.web.sstore.AbstractSession

AbstractSession(VertxContextPRNG, long, int) - Constructor for class io.vertx.ext.web.sstore.AbstractSession

accept() - Method in interface io.vertx.ext.web.ParsedHeaderValues

acceptableLanguages() - Method in interface io.vertx.ext.web.RoutingContext

Returns the languages for the current request.

acceptCharset() - Method in interface io.vertx.ext.web.ParsedHeaderValues

acceptEncoding() - Method in interface io.vertx.ext.web.ParsedHeaderValues

acceptLanguage() - Method in interface io.vertx.ext.web.ParsedHeaderValues

add(AuthenticationHandler) - Method in interface io.vertx.ext.web.handler.ChainAuthHandler

Appends a auth provider to the chain.

addAuthorizationProvider(AuthorizationProvider) - Method in interface io.vertx.ext.web.handler.AuthorizationHandler

Adds a provider that shall be used to retrieve the required authorizations for the user to attest.

addBodyEndHandler(Handler<Void>) - Method in interface io.vertx.ext.web.RoutingContext

Provides a handler that will be called after the last part of the body is written to the wire.

addDefaultHandler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.handler.MultiTenantHandler

Add a default handler for the case when no tenant was matched.

addDirective(String, String) - Method in interface io.vertx.ext.web.handler.CSPHandler

Adds a single directive entry to the handler.

addDisabledTransport(String) - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Add a transport (by name) to the set of disabled transports.

addEndHandler(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.web.RoutingContext

Add an end handler for the request/response context.

addHeadersEndHandler(Handler<Void>) - Method in interface io.vertx.ext.web.RoutingContext

Add a handler that will be called just before headers are written to the response.

addInboundPermitted(PermittedOptions) - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

addOrigin(String) - Method in interface io.vertx.ext.web.handler.CorsHandler

Add an origin to the list of allowed Origins.

addOrigins(List<String>) - Method in interface io.vertx.ext.web.handler.CorsHandler

Set the list of allowed origins.

addOriginsWithRegex(List<String>) - Method in interface io.vertx.ext.web.handler.CorsHandler

Set the list of allowed regex origins.

addOriginWithRegex(String) - Method in interface io.vertx.ext.web.handler.CorsHandler

Add a regex origin to the list of allowed Origins.

addOutboundPermitted(PermittedOptions) - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

addTenantHandler(String, Handler<RoutingContext>) - Method in interface io.vertx.ext.web.handler.MultiTenantHandler

Add a handler for a given tenant to this handler.

all() - Static method in interface io.vertx.ext.web.handler.ChainAuthHandler

Create a chain authentication handler that will assert that all handlers pass the verification.

ALL - io.vertx.ext.web.AllowForwardHeaders

Will process both AllowForwardHeaders.FORWARD and AllowForwardHeaders.X_FORWARD.

allowCredentials(boolean) - Method in interface io.vertx.ext.web.handler.CorsHandler

Set whether credentials are allowed.

allowedHeader(String) - Method in interface io.vertx.ext.web.handler.CorsHandler

Add an allowed header

allowedHeaders(Set<String>) - Method in interface io.vertx.ext.web.handler.CorsHandler

Add a set of allowed headers

allowedMethod(HttpMethod) - Method in interface io.vertx.ext.web.handler.CorsHandler

Add an allowed method

allowedMethods(Set<HttpMethod>) - Method in interface io.vertx.ext.web.handler.CorsHandler

Add a set of allowed methods

allowForward(AllowForwardHeaders) - Method in interface io.vertx.ext.web.Router

Set whether the router should parse "forwarded"-type headers

AllowForwardHeaders - Enum in io.vertx.ext.web

What kind of forward header parsing are we allowing.

allowPrivateNetwork(boolean) - Method in interface io.vertx.ext.web.handler.CorsHandler

Set whether access from public to private networks are allowed.

any() - Static method in interface io.vertx.ext.web.handler.ChainAuthHandler

Create a chain authentication handler that will assert that any handler passes the verification.

APIKeyHandler - Interface in io.vertx.ext.web.handler

An authentication handler that provides API Key support.

asJsonArray() - Method in interface io.vertx.ext.web.RequestBody

asJsonArray(int) - Method in interface io.vertx.ext.web.RequestBody

Gets the current body buffer as a JsonArray.

asJsonObject() - Method in interface io.vertx.ext.web.RequestBody

asJsonObject(int) - Method in interface io.vertx.ext.web.RequestBody

Gets the current body buffer as a JsonObject.

asPojo(Class<R>) - Method in interface io.vertx.ext.web.RequestBody

asPojo(Class<R>, int) - Method in interface io.vertx.ext.web.RequestBody

asString() - Method in interface io.vertx.ext.web.RequestBody

asString(String) - Method in interface io.vertx.ext.web.RequestBody

Get the entire HTTP request body as a string, assuming the specified encoding.

attachment(String) - Method in interface io.vertx.ext.web.RoutingContext

Set Content-Disposition get to "attachment" with optional filename mime type.

authenticate(Function<RoutingContext, Future<User>>) - Method in interface io.vertx.ext.web.handler.SimpleAuthenticationHandler

This function will allow you to perform authentication the way you intended to.

authenticated() - Method in interface io.vertx.ext.web.UserContext

AuthenticationHandler - Interface in io.vertx.ext.web.handler

Base interface for auth handlers.

AuthorizationHandler - Interface in io.vertx.ext.web.handler

Base interface for authorization handlers that provide authorization support.

available() - Method in interface io.vertx.ext.web.RequestBody

Return true if a BodyHandler was executed before this call in the lifetime of the request.

B

BasicAuthHandler - Interface in io.vertx.ext.web.handler

An auth handler that provides HTTP Basic Authentication support.

blockingHandler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.Route

Like Route.blockingHandler(Handler, boolean) called with ordered = true

blockingHandler(Handler<RoutingContext>, boolean) - Method in interface io.vertx.ext.web.Route

Specify a blocking request handler for the route.

body() - Method in interface io.vertx.ext.web.RoutingContext

BodyHandler - Interface in io.vertx.ext.web.handler

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

bridge(AuthorizationProvider, SockJSBridgeOptions, Handler<BridgeEvent>) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSHandler

Like SockJSHandler.bridge(SockJSBridgeOptions) but specifying a handler that will receive bridge events.

bridge(SockJSBridgeOptions) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSHandler

Bridge the SockJS handler to the Vert.x event bus.

bridge(SockJSBridgeOptions, Handler<BridgeEvent>) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSHandler

Like SockJSHandler.bridge(SockJSBridgeOptions) but specifying a handler that will receive bridge events.

BridgeEvent - Interface in io.vertx.ext.web.handler.sockjs

Represents an event that occurs on the event bus bridge.

buffer() - Method in interface io.vertx.ext.web.RequestBody

C

cancel() - Method in interface io.vertx.ext.web.FileUpload

Try to cancel the file upload.

cancelAndCleanupFileUploads() - Method in interface io.vertx.ext.web.RoutingContext

Cancel all unfinished file upload in progress and delete all uploaded files.

ChainAuthHandler - Interface in io.vertx.ext.web.handler

An auth handler that chains to a sequence of handlers.

charSet() - Method in interface io.vertx.ext.web.FileUpload

checksum() - Method in class io.vertx.ext.web.sstore.AbstractSession

clear() - Method in interface io.vertx.ext.web.Router

Remove all the routes from this router

clear() - Method in interface io.vertx.ext.web.sstore.SessionStore

Remove all sessions from the store.

clear() - Method in interface io.vertx.ext.web.UserContext

Clear can be called from any route handler which needs to terminate a login session.

close() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

Close it

close() - Method in interface io.vertx.ext.web.sstore.SessionStore

Close the store

close(int, String) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

Close it giving a status code and reason.

closeHandler(Handler<Void>) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

ClusteredSessionStore - Interface in io.vertx.ext.web.sstore

A session store which stores sessions in a distributed map so they are available across the cluster.

COMBINED - io.vertx.ext.web.handler.LoggerFormat

remote-client - user [timestamp in strftime format] "method uri version" status content-length "referrer" "user-agent"

component() - Method in interface io.vertx.ext.web.MIMEHeader

Gets the parsed component part of the MIME.

computeIfAbsent(String, Function<String, Object>) - Method in interface io.vertx.ext.web.Session

Put some data in a session if absent.

computeIfAbsent(String, Function<String, Object>) - Method in class io.vertx.ext.web.sstore.AbstractSession

connect() - Method in interface io.vertx.ext.web.Router

Add a route that matches any HTTP CONNECT request

connect(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP CONNECT request and the specified path

connectWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP CONNECT request and the specified path regex

consumes(String) - Method in interface io.vertx.ext.web.Route

Add a content type consumed by this route.

contentTransferEncoding() - Method in interface io.vertx.ext.web.FileUpload

contentType() - Method in interface io.vertx.ext.web.FileUpload

contentType() - Method in interface io.vertx.ext.web.ParsedHeaderValues

cookie(String) - Method in interface io.vertx.ext.web.handler.APIKeyHandler

Specify the source for the api key extraction as an HTTP cookie with the given name.

CorsHandler - Interface in io.vertx.ext.web.handler

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

crc() - Method in class io.vertx.ext.web.sstore.AbstractSession

create() - Static method in interface io.vertx.ext.web.handler.AuthorizationHandler

create the handler that will check the attribute based authorization.

create() - Static method in interface io.vertx.ext.web.handler.BodyHandler

Create a body handler with defaults.

create() - Static method in interface io.vertx.ext.web.handler.CorsHandler

Create a empty CORS handler that allows * origin.

create() - Static method in interface io.vertx.ext.web.handler.CSPHandler

Creates a new instance of the handler.

create() - Static method in interface io.vertx.ext.web.handler.HSTSHandler

Creates a new instance that does not consider the configuration for sub domains.

create() - Static method in interface io.vertx.ext.web.handler.LoggerHandler

Create a handler with default format

create() - Static method in interface io.vertx.ext.web.handler.MethodOverrideHandler

Create a X-HTTP-METHOD-OVERRIDE handler with safe downgrade of methods

create() - Static method in interface io.vertx.ext.web.handler.ResponseContentTypeHandler

Create a response content type handler.

create() - Static method in interface io.vertx.ext.web.handler.ResponseTimeHandler

Create a handler

create() - Static method in interface io.vertx.ext.web.handler.SecurityAuditLoggerHandler

Create a new instance of the handler.

create() - Static method in interface io.vertx.ext.web.handler.SimpleAuthenticationHandler

Creates a new instance of the simple authentication handler.

create() - Static method in interface io.vertx.ext.web.handler.StaticHandler

Create a handler using defaults

create() - Static method in interface io.vertx.ext.web.handler.TimeoutHandler

Create a handler

create(boolean) - Static method in interface io.vertx.ext.web.handler.BodyHandler

Create a body handler setting if it should handle file uploads.

create(boolean) - Static method in interface io.vertx.ext.web.handler.HSTSHandler

Creates a new instance that shall consider the configuration for sub domains.

create(boolean) - Static method in interface io.vertx.ext.web.handler.MethodOverrideHandler

Create a X-HTTP-METHOD-OVERRIDE handler

create(boolean, LoggerFormat) - Static method in interface io.vertx.ext.web.handler.LoggerHandler

Create a handler with he specified format

create(long) - Static method in interface io.vertx.ext.web.handler.TimeoutHandler

Create a handler

create(long, boolean) - Static method in interface io.vertx.ext.web.handler.HSTSHandler

Creates a new instance that shall consider the configuration for sub domains.

create(long, int) - Static method in interface io.vertx.ext.web.handler.TimeoutHandler

Create a handler

create(Vertx) - Static method in interface io.vertx.ext.web.handler.ErrorHandler

Create an error handler using defaults

create(Vertx) - Static method in interface io.vertx.ext.web.handler.FaviconHandler

Create a handler with defaults

create(Vertx) - Static method in interface io.vertx.ext.web.handler.sockjs.SockJSHandler

Create a SockJS handler

create(Vertx) - Static method in interface io.vertx.ext.web.healthchecks.HealthCheckHandler

Creates an instance of the default implementation of the HealthCheckHandler.

create(Vertx) - Static method in interface io.vertx.ext.web.sstore.ClusteredSessionStore

Create a session store

create(Vertx) - Static method in interface io.vertx.ext.web.sstore.LocalSessionStore

Create a session store

create(Vertx) - Static method in interface io.vertx.ext.web.sstore.SessionStore

Create a Session store given a backend and configuration JSON.

create(Vertx, boolean) - Static method in interface io.vertx.ext.web.handler.ErrorHandler

Create an error handler

create(Vertx, long) - Static method in interface io.vertx.ext.web.handler.FaviconHandler

Create a handler with the specified max cache time

create(Vertx, long) - Static method in interface io.vertx.ext.web.sstore.ClusteredSessionStore

Create a session store.

create(Vertx, JsonObject) - Static method in interface io.vertx.ext.web.sstore.SessionStore

Create a Session store given a backend and configuration JSON.

create(Vertx, AuthenticationProvider) - Static method in interface io.vertx.ext.web.healthchecks.HealthCheckHandler

Creates an instance of the default implementation of the HealthCheckHandler.

create(Vertx, HtdigestAuth) - Static method in interface io.vertx.ext.web.handler.DigestAuthHandler

Create a digest auth handler

create(Vertx, HtdigestAuth, long) - Static method in interface io.vertx.ext.web.handler.DigestAuthHandler

Create a digest auth handler, specifying the expire timeout for nonces.

create(Vertx, OAuth2Auth) - Static method in interface io.vertx.ext.web.handler.OAuth2AuthHandler

Create a OAuth2 auth handler without host pinning.Most providers will not look to the redirect url but always redirect to the preconfigured callback.

create(Vertx, OAuth2Auth, String) - Static method in interface io.vertx.ext.web.handler.OAuth2AuthHandler

Create a OAuth2 auth handler with host pinning.

create(Vertx, SockJSHandlerOptions) - Static method in interface io.vertx.ext.web.handler.sockjs.SockJSHandler

Create a SockJS handler

create(Vertx, String) - Static method in interface io.vertx.ext.web.handler.CSRFHandler

Instantiate a new CSRFHandlerImpl with a secret

create(Vertx, String) - Static method in interface io.vertx.ext.web.handler.ErrorHandler

Create an error handler

create(Vertx, String) - Static method in interface io.vertx.ext.web.handler.FaviconHandler

Create a handler attempting to load favicon file from the specified path

create(Vertx, String) - Static method in interface io.vertx.ext.web.sstore.ClusteredSessionStore

Create a session store

create(Vertx, String) - Static method in interface io.vertx.ext.web.sstore.LocalSessionStore

Create a session store

create(Vertx, String, boolean) - Static method in interface io.vertx.ext.web.handler.ErrorHandler

Create an error handler

create(Vertx, String, long) - Static method in interface io.vertx.ext.web.handler.FaviconHandler

Create a handler attempting to load favicon file from the specified path, and with the specified max cache time

create(Vertx, String, long) - Static method in interface io.vertx.ext.web.sstore.ClusteredSessionStore

Create a session store.

create(Vertx, String, long) - Static method in interface io.vertx.ext.web.sstore.LocalSessionStore

Create a session store

create(AuthenticationProvider) - Static method in interface io.vertx.ext.web.handler.APIKeyHandler

Create an API Key authentication handler

create(AuthenticationProvider) - Static method in interface io.vertx.ext.web.handler.BasicAuthHandler

Create a basic auth handler

create(AuthenticationProvider) - Static method in interface io.vertx.ext.web.handler.FormLoginHandler

Create a handler

create(AuthenticationProvider) - Static method in interface io.vertx.ext.web.handler.RedirectAuthHandler

Create a handler

create(AuthenticationProvider, String) - Static method in interface io.vertx.ext.web.handler.BasicAuthHandler

Create a basic auth handler, specifying realm

create(AuthenticationProvider, String) - Static method in interface io.vertx.ext.web.handler.RedirectAuthHandler

Create a handler

create(AuthenticationProvider, String, String) - Static method in interface io.vertx.ext.web.handler.RedirectAuthHandler

Create a handler

create(AuthenticationProvider, String, String, String, String) - Static method in interface io.vertx.ext.web.handler.FormLoginHandler

Create a handler

create(Authorization) - Static method in interface io.vertx.ext.web.handler.AuthorizationHandler

create the handler that will check the specified authorization Note that to check several authorizations, you can specify a sub-interface such as AndAuthorization or OrAuthorization

create(JWTAuth) - Static method in interface io.vertx.ext.web.handler.JWTAuthHandler

Create a JWT auth handler.

create(JWTAuth, String) - Static method in interface io.vertx.ext.web.handler.JWTAuthHandler

Create a JWT auth handler.

create(HotpAuth) - Static method in interface io.vertx.ext.web.handler.OtpAuthHandler

Create a new instance of this handler using a hash based one time password authentication provider.

create(TotpAuth) - Static method in interface io.vertx.ext.web.handler.OtpAuthHandler

Create a new instance of this handler using a time based one time password authentication provider.

create(WebAuthn4J) - Static method in interface io.vertx.ext.web.handler.WebAuthn4JHandler

Create a WebAuthN auth handler.

create(TemplateEngine) - Static method in interface io.vertx.ext.web.handler.TemplateHandler

Create a handler

create(TemplateEngine, String, String) - Static method in interface io.vertx.ext.web.handler.TemplateHandler

Create a handler

create(FileSystemAccess, String) - Static method in interface io.vertx.ext.web.handler.StaticHandler

Create a handler, specifying web-root and access option: absolute path or relative

create(LoggerFormat) - Static method in interface io.vertx.ext.web.handler.LoggerHandler

Create a handler with he specified format

create(SessionStore) - Static method in interface io.vertx.ext.web.handler.SessionHandler

Create a session handler

create(String) - Static method in interface io.vertx.ext.web.handler.BodyHandler

Create a body handler and use the given upload directory.

create(String) - Static method in interface io.vertx.ext.web.handler.MultiTenantHandler

Create a MultiTenant handler that will extract the tenant id from a given header name.

create(String) - Static method in interface io.vertx.ext.web.handler.ResponseContentTypeHandler

Create a response content type handler with a custom disable flag.

create(String) - Static method in interface io.vertx.ext.web.handler.StaticHandler

Create a handler, specifying web-root

create(String) - Static method in interface io.vertx.ext.web.handler.XFrameHandler

Creates a new handler that will add the X-FRAME-OPTIONS header to the current response.

create(Function<RoutingContext, String>) - Static method in interface io.vertx.ext.web.handler.MultiTenantHandler

Create a MultiTenant handler using a custom tenant extraction function.

create(Function<RoutingContext, String>, String) - Static method in interface io.vertx.ext.web.handler.MultiTenantHandler

Create a MultiTenant handler using a custom tenant extraction function.

createSession(long) - Method in interface io.vertx.ext.web.sstore.SessionStore

Create a new session using the default min length.

createSession(long, int) - Method in interface io.vertx.ext.web.sstore.SessionStore

Create a new session.

createWithHealthChecks(HealthChecks) - Static method in interface io.vertx.ext.web.healthchecks.HealthCheckHandler

Creates an instance of the default implementation of the HealthCheckHandler.

createWithHealthChecks(HealthChecks, AuthenticationProvider) - Static method in interface io.vertx.ext.web.healthchecks.HealthCheckHandler

Creates an instance of the default implementation of the HealthCheckHandler.

CSPHandler - Interface in io.vertx.ext.web.handler

Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.

CSRFHandler - Interface in io.vertx.ext.web.handler

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

currentRoute() - Method in interface io.vertx.ext.web.RoutingContext

CUSTOM - io.vertx.ext.web.handler.LoggerFormat

Will use user defined formatter function.

customFormatter(LoggerFormatter) - Method in interface io.vertx.ext.web.handler.LoggerHandler

Set the custom formatter to be used by the handler.

D

data() - Method in interface io.vertx.ext.web.RoutingContext

data() - Method in interface io.vertx.ext.web.Session

data() - Method in class io.vertx.ext.web.sstore.AbstractSession

DEFAULT - io.vertx.ext.web.handler.LoggerFormat

remote-client - - [timestamp] "method uri version" status content-length "referrer" "user-agent"

DEFAULT_ALWAYS_ASYNC_FS - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default of whether async filesystem access should always be used

DEFAULT_BODY_LIMIT - Static variable in interface io.vertx.ext.web.handler.BodyHandler

Default max size for a request body in bytes = 10485760, i.e. 10 megabytes

DEFAULT_CACHE_ENTRY_TIMEOUT - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default cache entry timeout, when caching

DEFAULT_CACHING_ENABLED - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default of whether cache header handling is enabled

DEFAULT_CONTENT_TYPE - Static variable in interface io.vertx.ext.web.handler.TemplateHandler

The default content type header to be used in the response

DEFAULT_COOKIE_HTTP_ONLY_FLAG - Static variable in interface io.vertx.ext.web.handler.SessionHandler

Default of whether the cookie has the HttpOnly flag set More info: https://www.owasp.org/index.php/HttpOnly

DEFAULT_COOKIE_NAME - Static variable in interface io.vertx.ext.web.handler.CSRFHandler

DEFAULT_COOKIE_PATH - Static variable in interface io.vertx.ext.web.handler.CSRFHandler

DEFAULT_COOKIE_SECURE_FLAG - Static variable in interface io.vertx.ext.web.handler.SessionHandler

Default of whether the cookie has the 'secure' flag set to allow transmission over https only.

DEFAULT_DELETE_UPLOADED_FILES_ON_END - Static variable in interface io.vertx.ext.web.handler.BodyHandler

Default value of whether uploaded files should be removed after handling the request

DEFAULT_DIRECTORY_LISTING - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default of whether directory listing is enabled

DEFAULT_DIRECTORY_TEMPLATE - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default template file to use for directory listing

DEFAULT_DISABLE_FLAG - Static variable in interface io.vertx.ext.web.handler.ResponseContentTypeHandler

DEFAULT_ENABLE_FS_TUNING - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default of whether fs async/sync tuning should be used

DEFAULT_ERROR_HANDLER_TEMPLATE - Static variable in interface io.vertx.ext.web.handler.ErrorHandler

The default template to use for rendering

DEFAULT_ERRORCODE - Static variable in interface io.vertx.ext.web.handler.TimeoutHandler

The default error code

DEFAULT_FILES_READ_ONLY - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default value of whether files are read -only and never will be updated

DEFAULT_FORMAT - Static variable in interface io.vertx.ext.web.handler.LoggerHandler

DEFAULT_HEADER_NAME - Static variable in interface io.vertx.ext.web.handler.CSRFHandler

DEFAULT_HEARTBEAT_INTERVAL - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

The default interval between heartbeat packets.

DEFAULT_INCLUDE_HIDDEN - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default of whether hidden files can be served

DEFAULT_INDEX_PAGE - Static variable in interface io.vertx.ext.web.handler.StaticHandler

The default index page

DEFAULT_INDEX_TEMPLATE - Static variable in interface io.vertx.ext.web.handler.TemplateHandler

The default index page

DEFAULT_INSERT_JSESSIONID - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Whether a JSESSIONID cookie should be inserted by default = true.

DEFAULT_LAZY_SESSION - Static variable in interface io.vertx.ext.web.handler.SessionHandler

Default of whether the session should be created lazily.

DEFAULT_LIBRARY_URL - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

The default SockJS library URL to load in iframe when a transport does not support cross-domain communication natively.

DEFAULT_LOCAL_WRITE_HANDLER - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Whether the writeHandler should be registered as local by default = true.

DEFAULT_LOGIN_REDIRECT_URL - Static variable in interface io.vertx.ext.web.handler.RedirectAuthHandler

Default path the user will be redirected to

DEFAULT_MAX_ADDRESS_LENGTH - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

Default value for max address length = 200

DEFAULT_MAX_AGE - Static variable in interface io.vertx.ext.web.handler.HSTSHandler

DEFAULT_MAX_AGE_SECONDS - Static variable in interface io.vertx.ext.web.handler.FaviconHandler

The default max age in seconds as set in the cache-control header

DEFAULT_MAX_AGE_SECONDS - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default max age for cache headers

DEFAULT_MAX_AVG_SERVE_TIME_NS - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default max avg serve time, in ns, over which serving will be considered slow

DEFAULT_MAX_BYTES_STREAMING - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

The default maximum number of bytes an HTTP streaming request can send.

DEFAULT_MAX_CACHE_SIZE - Static variable in interface io.vertx.ext.web.handler.StaticHandler

The default max cache size

DEFAULT_MAX_HANDLERS_PER_SOCKET - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

Default value for max handlers per socket = 1000

DEFAULT_MERGE_FORM_ATTRIBUTES - Static variable in interface io.vertx.ext.web.handler.BodyHandler

Default value of whether form attributes should be merged into request params

DEFAULT_NAG_HTTPS - Static variable in interface io.vertx.ext.web.handler.SessionHandler

Default of whether a nagging log warning should be written if the session handler is accessed over HTTP, not HTTPS

DEFAULT_NONCE_EXPIRE_TIMEOUT - Static variable in interface io.vertx.ext.web.handler.DigestAuthHandler

The default nonce expire timeout to use in milliseconds.

DEFAULT_PASSWORD_PARAM - Static variable in interface io.vertx.ext.web.handler.FormLoginHandler

The default value of the form attribute which will contain the password

DEFAULT_PING_TIMEOUT - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

Default value for ping timeout = 10000 ms

DEFAULT_PREALLOCATE_BODY_BUFFER - Static variable in interface io.vertx.ext.web.handler.BodyHandler

Default value of whether to pre-allocate the body buffer size according to the content-length HTTP request header

DEFAULT_RANGE_SUPPORT - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default of whether Range request handling support should be used

DEFAULT_REALM - Static variable in interface io.vertx.ext.web.handler.BasicAuthHandler

The default realm to use

DEFAULT_REAPER_INTERVAL - Static variable in interface io.vertx.ext.web.sstore.LocalSessionStore

Default of how often, in ms, to check for expired sessions

DEFAULT_REGISTER_WRITE_HANDLER - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Whether a writeHandler should be registered by default = false.

DEFAULT_REPLY_TIMEOUT - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

Default value for reply timeout = 30000

DEFAULT_RETRY_TIMEOUT - Static variable in interface io.vertx.ext.web.sstore.ClusteredSessionStore

Default retry time out, in ms, for a session not found in this store.

DEFAULT_RETURN_URL_PARAM - Static variable in interface io.vertx.ext.web.handler.FormLoginHandler

The default value of the session attribute which will contain the return url

DEFAULT_RETURN_URL_PARAM - Static variable in interface io.vertx.ext.web.handler.RedirectAuthHandler

Default name of param used to store return url information in session

DEFAULT_ROOT_FILESYSTEM_ACCESS - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default of whether access to the root of the file system should be allowed or just allow from the current working directory.

DEFAULT_SEND_VARY_HEADER - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default of whether vary header should be sent.

DEFAULT_SESSION_COOKIE_NAME - Static variable in interface io.vertx.ext.web.handler.SessionHandler

Default name of session cookie

DEFAULT_SESSION_COOKIE_PATH - Static variable in interface io.vertx.ext.web.handler.SessionHandler

Default path of session cookie

DEFAULT_SESSION_MAP_NAME - Static variable in interface io.vertx.ext.web.sstore.ClusteredSessionStore

The default name used for the session map

DEFAULT_SESSION_MAP_NAME - Static variable in interface io.vertx.ext.web.sstore.LocalSessionStore

Default name for map used to store sessions

DEFAULT_SESSION_TIMEOUT - Static variable in interface io.vertx.ext.web.handler.SessionHandler

Default time, in ms, that a session lasts for without being accessed before expiring.

DEFAULT_SESSION_TIMEOUT - Static variable in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

The default delay before sending a close event to a silent client.

DEFAULT_SESSIONID_LENGTH - Static variable in interface io.vertx.ext.web.sstore.SessionStore

Default length for a session id.

DEFAULT_SESSIONID_MIN_LENGTH - Static variable in interface io.vertx.ext.web.handler.SessionHandler

Default min length for a session id.

DEFAULT_TEMPLATE_DIRECTORY - Static variable in interface io.vertx.ext.web.handler.TemplateHandler

The default directory where templates will be looked for

DEFAULT_TIMEOUT - Static variable in interface io.vertx.ext.web.handler.TimeoutHandler

The default timeout, in ms

DEFAULT_UPLOADS_DIRECTORY - Static variable in interface io.vertx.ext.web.handler.BodyHandler

Default uploads directory on server for file uploads

DEFAULT_USERNAME_PARAM - Static variable in interface io.vertx.ext.web.handler.FormLoginHandler

The default value of the form attribute which will contain the username

DEFAULT_WEB_ROOT - Static variable in interface io.vertx.ext.web.handler.StaticHandler

Default value of the web-root, where files are served from

DEFAULT_WEIGHT - Static variable in interface io.vertx.ext.web.ParsedHeaderValue

If no "q" parameter is present, the default weight is 1.

delete() - Method in interface io.vertx.ext.web.FileUpload

Delete the uploaded file on the disk.

delete() - Method in interface io.vertx.ext.web.Router

Add a route that matches any HTTP DELETE request

delete(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP DELETE request and the specified path

delete(String) - Method in interface io.vertx.ext.web.sstore.SessionStore

Delete the session with the specified ID.

deleteWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP DELETE request and the specified path regex

DENY - Static variable in interface io.vertx.ext.web.handler.XFrameHandler

The page cannot be displayed in a frame, regardless of the site attempting to do so.

destroy() - Method in interface io.vertx.ext.web.Session

Destroy the session

destroy() - Method in class io.vertx.ext.web.sstore.AbstractSession

DigestAuthHandler - Interface in io.vertx.ext.web.handler

An auth handler that provides HTTP Basic Authentication support.

disable() - Method in interface io.vertx.ext.web.Route

Disable this route.

drainHandler(Handler<Void>) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

E

enable() - Method in interface io.vertx.ext.web.Route

Enable this route.

end() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

Call SockJSSocket.close().

end() - Method in interface io.vertx.ext.web.RoutingContext

Shortcut to the response end.

end(Buffer) - Method in interface io.vertx.ext.web.RoutingContext

Shortcut to the response end.

end(String) - Method in interface io.vertx.ext.web.RoutingContext

Shortcut to the response end.

endHandler(Handler<Void>) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

errorHandler(int, Handler<RoutingContext>) - Method in interface io.vertx.ext.web.Router

Specify an handler to handle an error for a particular status code.

ErrorHandler - Interface in io.vertx.ext.web.handler

A pretty error handler for rendering error pages.

etag(String) - Method in interface io.vertx.ext.web.RoutingContext

Set the ETag of a response.

EVENT_SOURCE - io.vertx.ext.web.handler.sockjs.Transport

Event source

exceptionHandler(Handler<Throwable>) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

exposedHeader(String) - Method in interface io.vertx.ext.web.handler.CorsHandler

Add an exposed header

exposedHeaders(Set<String>) - Method in interface io.vertx.ext.web.handler.CorsHandler

Add a set of exposed headers

extraParams(JsonObject) - Method in interface io.vertx.ext.web.handler.OAuth2AuthHandler

Extra parameters needed to be passed while requesting a token.

F

fail(int) - Method in interface io.vertx.ext.web.RoutingContext

Fail the context with the specified status code.

fail(int, Throwable) - Method in interface io.vertx.ext.web.RoutingContext

Fail the context with the specified throwable and the specified the status code.

fail(Throwable) - Method in interface io.vertx.ext.web.RoutingContext

Fail the context with the specified throwable and 500 status code.

failed() - Method in interface io.vertx.ext.web.RoutingContext

failure() - Method in interface io.vertx.ext.web.RoutingContext

If the context is being routed to failure handlers after a failure has been triggered by calling RoutingContext.fail(Throwable) then this will return that throwable.

failureHandler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.Route

Append a failure handler to the route failure handlers list.

FaviconHandler - Interface in io.vertx.ext.web.handler

A handler that serves favicons.

fetch(long) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

fileName() - Method in interface io.vertx.ext.web.FileUpload

FileSystemAccess - Enum in io.vertx.ext.web.handler

Enumaration of FileSystem access permissions, used in

FileUpload - Interface in io.vertx.ext.web

Represents a file-upload from an HTTP multipart form submission.

fileUploads() - Method in interface io.vertx.ext.web.RoutingContext

findBestUserAcceptedIn(List<MIMEHeader>, Collection<MIMEHeader>) - Method in interface io.vertx.ext.web.ParsedHeaderValues

Given the sorted list of parsed header values the user has sent and an Iterable of acceptable values: It finds the first accepted header that matches any inside the Iterable.

findMatchedBy(Collection<T>) - Method in interface io.vertx.ext.web.ParsedHeaderValue

Finds the first ParsedHeaderValue in the list that matches with this header value.

flush(RoutingContext) - Method in interface io.vertx.ext.web.handler.SessionHandler

Flush a context session earlier to the store, this will allow the end user to have full control on the event of a failure at the store level.

flush(RoutingContext, boolean) - Method in interface io.vertx.ext.web.handler.SessionHandler

Flush a context session earlier to the store, this will allow the end user to have full control on the event of a failure at the store level.

flushed(boolean) - Method in class io.vertx.ext.web.sstore.AbstractSession

format(RoutingContext, long) - Method in interface io.vertx.ext.web.handler.LoggerFormatter

Formats and returns the log statement

FormLoginHandler - Interface in io.vertx.ext.web.handler

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

FORWARD - io.vertx.ext.web.AllowForwardHeaders

Only process the standard Forward header as defined by

G

get() - Method in interface io.vertx.ext.web.Router

Add a route that matches any HTTP GET request

get() - Method in interface io.vertx.ext.web.UserContext

Get the authenticated user (if any).

get(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP GET request and the specified path

get(String) - Method in interface io.vertx.ext.web.RoutingContext

Get some data from the context.

get(String) - Method in interface io.vertx.ext.web.Session

Get some data from the session

get(String) - Method in class io.vertx.ext.web.sstore.AbstractSession

get(String) - Method in interface io.vertx.ext.web.sstore.SessionStore

Get the session with the specified ID.

get(String, T) - Method in interface io.vertx.ext.web.RoutingContext

Get some data from the context.

getAcceptableContentType() - Method in interface io.vertx.ext.web.RoutingContext

If the route specifies produces matches, e.g. produces `text/html` and `text/plain`, and the `accept` header matches one or more of these then this returns the most acceptable match.

getDisabledTransports() - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

getExtensionTarget() - Method in class io.vertx.ext.web.Http2PushMapping

getFilePath() - Method in class io.vertx.ext.web.Http2PushMapping

getHeartbeatInterval() - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

getLibraryURL() - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

getMaxAddressLength() - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

getMaxBytesStreaming() - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

getMaxHandlersPerSocket() - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

getMetadata(String) - Method in interface io.vertx.ext.web.Route

Get some data from metadata.

getMetadata(String) - Method in interface io.vertx.ext.web.Router

Get some data from metadata.

getName() - Method in interface io.vertx.ext.web.Route

getOrigin() - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

getPath() - Method in interface io.vertx.ext.web.Route

getPayload() - Method in exception io.vertx.ext.web.handler.HttpException

getPingTimeout() - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

getReplyTimeout() - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

getRoutes() - Method in interface io.vertx.ext.web.Router

getSessionTimeout() - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

getStatusCode() - Method in exception io.vertx.ext.web.handler.HttpException

getSubRouter() - Method in interface io.vertx.ext.web.Route

getWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP GET request and the specified path regex

H

handleContext(RoutingContext) - Method in interface io.vertx.ext.web.Router

Used to route a context to the router.

handleFailure(RoutingContext) - Method in interface io.vertx.ext.web.Router

Used to route a failure to the router.

handler(Handler<Buffer>) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

handler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.Route

Append a request handler to the route handlers list.

head() - Method in interface io.vertx.ext.web.Router

Add a route that matches any HTTP HEAD request

head(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP HEAD request and the specified path

header(String) - Method in interface io.vertx.ext.web.handler.APIKeyHandler

Specify the source for the api key extraction as an HTTP header with the given name.

headers() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasons

headWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP HEAD request and the specified path regex

HealthCheckHandler - Interface in io.vertx.ext.web.healthchecks

A Vert.x Web handler on which you register health check procedure.

HSTSHandler - Interface in io.vertx.ext.web.handler

HTTP Strict Transport Security (HSTS) RFC6797.

HTML_FILE - io.vertx.ext.web.handler.sockjs.Transport

HtmlFile.

Http2PushMapping - Class in io.vertx.ext.web

Http2PushMapping() - Constructor for class io.vertx.ext.web.Http2PushMapping

Default constructor

Http2PushMapping(JsonObject) - Constructor for class io.vertx.ext.web.Http2PushMapping

Constructor from JSON

Http2PushMapping(Http2PushMapping) - Constructor for class io.vertx.ext.web.Http2PushMapping

Copy constructor

Http2PushMapping(String, String, boolean) - Constructor for class io.vertx.ext.web.Http2PushMapping

Constructor with params for Link preload

Http2PushMappingConverter - Class in io.vertx.ext.web

Converter and mapper for Http2PushMapping.

Http2PushMappingConverter() - Constructor for class io.vertx.ext.web.Http2PushMappingConverter

HttpException - Exception in io.vertx.ext.web.handler

An utility exception class to signal HTTP failures.

HttpException() - Constructor for exception io.vertx.ext.web.handler.HttpException

HttpException(int) - Constructor for exception io.vertx.ext.web.handler.HttpException

HttpException(int, String) - Constructor for exception io.vertx.ext.web.handler.HttpException

HttpException(int, String, Throwable) - Constructor for exception io.vertx.ext.web.handler.HttpException

HttpException(int, Throwable) - Constructor for exception io.vertx.ext.web.handler.HttpException

I

id() - Method in interface io.vertx.ext.web.Session

id() - Method in class io.vertx.ext.web.sstore.AbstractSession

impersonate() - Method in interface io.vertx.ext.web.UserContext

Impersonates a second identity.

impersonate(String) - Method in interface io.vertx.ext.web.UserContext

Impersonates a second identity.

incrementVersion() - Method in class io.vertx.ext.web.sstore.AbstractSession

init(Vertx, JsonObject) - Method in interface io.vertx.ext.web.sstore.SessionStore

Initialize this store.

InputTrustHandler - Interface in io.vertx.ext.web.handler

Base input trust interface for handlers that verify the trust of the request.

io.vertx.ext.web - package io.vertx.ext.web

io.vertx.ext.web.handler - package io.vertx.ext.web.handler

io.vertx.ext.web.handler.sockjs - package io.vertx.ext.web.handler.sockjs

io.vertx.ext.web.healthchecks - package io.vertx.ext.web.healthchecks

io.vertx.ext.web.sstore - package io.vertx.ext.web.sstore

io.vertx.web - module io.vertx.web

is(String) - Method in interface io.vertx.ext.web.RoutingContext

Check if the incoming request contains the "Content-Type" get field, and it contains the give mime `type`.

isDestroyed() - Method in interface io.vertx.ext.web.Session

isDestroyed() - Method in class io.vertx.ext.web.sstore.AbstractSession

isEmpty() - Method in interface io.vertx.ext.web.RequestBody

A body can be empty if it is not available, or its length is 0.

isEmpty() - Method in interface io.vertx.ext.web.Session

isEmpty() - Method in class io.vertx.ext.web.sstore.AbstractSession

isExactPath() - Method in interface io.vertx.ext.web.Route

Returns true of the path doesn't end with a wildcard * or is null.

isFresh() - Method in interface io.vertx.ext.web.RoutingContext

Check if the request is fresh, aka Last-Modified and/or the ETag still match.

isInsertJSESSIONID() - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

isLocalWriteHandler() - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

isMatchedBy(ParsedHeaderValue) - Method in interface io.vertx.ext.web.ParsedHeaderValue

Test if this header is matched by matchTry header

isNoPush() - Method in class io.vertx.ext.web.Http2PushMapping

isPermitted() - Method in interface io.vertx.ext.web.ParsedHeaderValue

Is this an allowed operation as specified by the corresponding header?

isRegenerated() - Method in interface io.vertx.ext.web.Session

isRegenerated() - Method in class io.vertx.ext.web.sstore.AbstractSession

isRegexPath() - Method in interface io.vertx.ext.web.Route

Returns true of the path is a regular expression, this includes expression paths.

isRegisterWriteHandler() - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

isSessionAccessed() - Method in interface io.vertx.ext.web.RoutingContext

Whether the RoutingContext.session() has been already called or not.

issuer(String) - Method in interface io.vertx.ext.web.handler.OtpAuthHandler

Configure the issuer value to be shown in the authenticator URL.

J

json(Object) - Method in interface io.vertx.ext.web.RoutingContext

Encode an Object to JSON and end the request.

JSON_P - io.vertx.ext.web.handler.sockjs.Transport

Slow and old fashioned JSONP polling.

JWTAuthHandler - Interface in io.vertx.ext.web.handler

An auth handler that provides JWT Authentication support.

L

label(String) - Method in interface io.vertx.ext.web.handler.OtpAuthHandler

Configure the label value to be shown in the authenticator URL.

LanguageHeader - Interface in io.vertx.ext.web

A parsed language header.

last() - Method in interface io.vertx.ext.web.Route

Specify this is the last route for the router.

lastAccessed() - Method in interface io.vertx.ext.web.Session

lastAccessed() - Method in class io.vertx.ext.web.sstore.AbstractSession

lastModified(String) - Method in interface io.vertx.ext.web.RoutingContext

Set the Last-Modified date using a String.

lastModified(Instant) - Method in interface io.vertx.ext.web.RoutingContext

Set the Last-Modified date using a Instant.

length() - Method in interface io.vertx.ext.web.RequestBody

Returns the total length of the body buffer.

localAddress() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

Return the local address for this socket

LocalSessionStore - Interface in io.vertx.ext.web.sstore

A session store which is only available on a single node.

LoggerFormat - Enum in io.vertx.ext.web.handler

The possible out of the box formats.

LoggerFormatter - Interface in io.vertx.ext.web.handler

Implement to format the output of the LoggerHandler

LoggerHandler - Interface in io.vertx.ext.web.handler

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

loginHint(String) - Method in interface io.vertx.ext.web.UserContext

When performing a web identity operation, hint if possible to the identity provider to use the given login.

logout() - Method in interface io.vertx.ext.web.UserContext

Logout can be called from any route handler which needs to terminate a login session.

logout(String) - Method in interface io.vertx.ext.web.UserContext

Logout can be called from any route handler which needs to terminate a login session.

M

maxAgeSeconds(int) - Method in interface io.vertx.ext.web.handler.CorsHandler

Set how long the browser should cache the information

mediaType() - Method in interface io.vertx.ext.web.MIMEHeader

Gets the MIME media type string.

mediaTypeWithParams() - Method in interface io.vertx.ext.web.MIMEHeader

Gets the MIME media type string with parameters attached.

metadata() - Method in interface io.vertx.ext.web.Route

metadata() - Method in interface io.vertx.ext.web.Router

method(HttpMethod) - Method in interface io.vertx.ext.web.Route

Add an HTTP method for this route.

MethodOverrideHandler - Interface in io.vertx.ext.web.handler

methods() - Method in interface io.vertx.ext.web.Route

MIMEHeader - Interface in io.vertx.ext.web

modifiedHandler(Handler<Router>) - Method in interface io.vertx.ext.web.Router

When a Router routes are changed this handler is notified.

mountPoint() - Method in interface io.vertx.ext.web.RoutingContext

MultiTenantHandler - Interface in io.vertx.ext.web.handler

A handler which selectively executes another handler if a precondition is met.

N

name() - Method in interface io.vertx.ext.web.FileUpload

newSession(RoutingContext) - Method in interface io.vertx.ext.web.handler.SessionHandler

Create a new session

next() - Method in interface io.vertx.ext.web.RoutingContext

Tell the router to route this context to the next matching route (if any).

NONE - io.vertx.ext.web.AllowForwardHeaders

No parsing shall be performed.

normalizedPath() - Method in interface io.vertx.ext.web.RoutingContext

Normalizes a path as per

O

OAuth2AuthHandler - Interface in io.vertx.ext.web.handler

An auth handler that provides OAuth2 Authentication support.

oldId() - Method in interface io.vertx.ext.web.Session

oldId() - Method in class io.vertx.ext.web.sstore.AbstractSession

options() - Method in interface io.vertx.ext.web.Router

Add a route that matches any HTTP OPTIONS request

options(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP OPTIONS request and the specified path

optionsWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP OPTIONS request and the specified path regex

order(int) - Method in interface io.vertx.ext.web.Route

Specify the order for this route.

OtpAuthHandler - Interface in io.vertx.ext.web.handler

An auth handler that provides One Time Password (Multi-Factor) Authentication support.

P

parameter(String) - Method in interface io.vertx.ext.web.handler.APIKeyHandler

Specify the source for the api key extraction as an HTTP query parameter with the given name.

parameter(String) - Method in interface io.vertx.ext.web.ParsedHeaderValue

The value of the parameter specified by this key.

parameters() - Method in interface io.vertx.ext.web.ParsedHeaderValue

The parameters specified in this header value.

parsedHeaders() - Method in interface io.vertx.ext.web.RoutingContext

The headers: Accept Accept-Charset Accept-Encoding Accept-Language Content-Type Parsed into ParsedHeaderValue

ParsedHeaderValue - Interface in io.vertx.ext.web

ParsedHeaderValues - Interface in io.vertx.ext.web

A container with the request's headers that are meaningful enough to be parsed Contains: Accept -> MIME header, parameters and sortable Accept-Charset -> Parameters and sortable Accept-Encoding -> Parameters and sortable Accept-Language -> Parameters and sortable Content-Type -> MIME header and parameters

patch() - Method in interface io.vertx.ext.web.Router

Add a route that matches any HTTP PATCH request

patch(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP PATCH request and the specified path

patchWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP PATCH request and the specified path regex

path(String) - Method in interface io.vertx.ext.web.Route

Set the path prefix for this route.

pathParam(String) - Method in interface io.vertx.ext.web.RoutingContext

Gets the value of a single path parameter

pathParams() - Method in interface io.vertx.ext.web.RoutingContext

Returns a map of named parameters as defined in path declaration with their actual values

pathRegex(String) - Method in interface io.vertx.ext.web.Route

Set the path prefix as a regular expression.

pause() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

pkceVerifierLength(int) - Method in interface io.vertx.ext.web.handler.OAuth2AuthHandler

PKCE (RFC 7636) is an extension to the Authorization Code flow to prevent several attacks and to be able to securely perform the OAuth exchange from public clients.

PlatformHandler - Interface in io.vertx.ext.web.handler

Base platform interface for handlers that provide functionality to the application platform.

post() - Method in interface io.vertx.ext.web.Router

Add a route that matches any HTTP POST request

post(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP POST request and the specified path

postWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP POST request and the specified path regex

preferredLanguage() - Method in interface io.vertx.ext.web.RoutingContext

Helper to return the user preferred language.

produces(String) - Method in interface io.vertx.ext.web.Route

Add a content type produced by this route.

prompt(String) - Method in interface io.vertx.ext.web.handler.OAuth2AuthHandler

Indicates the type of user interaction that is required.

ProtocolUpgradeHandler - Interface in io.vertx.ext.web.handler

Base interface for handlers that perform protocol upgrades.

put() - Method in interface io.vertx.ext.web.Router

Add a route that matches any HTTP PUT request

put(Session) - Method in interface io.vertx.ext.web.sstore.SessionStore

Add a session with the specified ID.

put(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP PUT request and the specified path

put(String, Object) - Method in interface io.vertx.ext.web.RoutingContext

Put some arbitrary data in the context.

put(String, Object) - Method in interface io.vertx.ext.web.Session

Put some data in a session

put(String, Object) - Method in class io.vertx.ext.web.sstore.AbstractSession

putIfAbsent(String, Object) - Method in interface io.vertx.ext.web.Session

Put some data in a session if absent

putIfAbsent(String, Object) - Method in class io.vertx.ext.web.sstore.AbstractSession

putMetadata(String, Object) - Method in interface io.vertx.ext.web.Route

Put metadata to this route.

putMetadata(String, Object) - Method in interface io.vertx.ext.web.Router

Put metadata to this router.

putWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP PUT request and the specified path regex

Q

queryParam(String) - Method in interface io.vertx.ext.web.RoutingContext

Gets the value of a single query parameter.

queryParams() - Method in interface io.vertx.ext.web.RoutingContext

Returns a map of all query parameters inside the query string
The query parameters are lazily decoded: the decoding happens on the first time this method is called.

queryParams(Charset) - Method in interface io.vertx.ext.web.RoutingContext

Always decode the current query string with the given encoding.

R

rawValue() - Method in interface io.vertx.ext.web.ParsedHeaderValue

Contains the raw value that was received from the user agent

readDataFromBuffer(int, Buffer) - Method in class io.vertx.ext.web.sstore.AbstractSession

readDataFromBuffer(Buffer) - Method in class io.vertx.ext.web.sstore.AbstractSession

redirect(String) - Method in interface io.vertx.ext.web.RoutingContext

Perform a 302 redirect to url.

RedirectAuthHandler - Interface in io.vertx.ext.web.handler

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

refresh() - Method in interface io.vertx.ext.web.UserContext

Forces the current user to re-authenticate.

refresh(String) - Method in interface io.vertx.ext.web.UserContext

Forces the current user to re-authenticate.

regenerateId() - Method in interface io.vertx.ext.web.Session

regenerateId() - Method in class io.vertx.ext.web.sstore.AbstractSession

register(String, long, Handler<Promise<Status>>) - Method in interface io.vertx.ext.web.healthchecks.HealthCheckHandler

Registers a health check procedure.

register(String, Handler<Promise<Status>>) - Method in interface io.vertx.ext.web.healthchecks.HealthCheckHandler

Registers a health check procedure.

RELATIVE - io.vertx.ext.web.handler.FileSystemAccess

Access to files relative to the application's working directory including the Java class path.

remoteAddress() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

Return the remote address for this socket

remove() - Method in interface io.vertx.ext.web.Route

Remove this route from the router

remove(String) - Method in interface io.vertx.ext.web.RoutingContext

Remove some data from the context.

remove(String) - Method in interface io.vertx.ext.web.Session

Remove some data from the session

remove(String) - Method in class io.vertx.ext.web.sstore.AbstractSession

removeBodyEndHandler(int) - Method in interface io.vertx.ext.web.RoutingContext

Remove a body end handler

removeEndHandler(int) - Method in interface io.vertx.ext.web.RoutingContext

Remove an end handler

removeHeadersEndHandler(int) - Method in interface io.vertx.ext.web.RoutingContext

Remove a headers end handler

removeTenant(String) - Method in interface io.vertx.ext.web.handler.MultiTenantHandler

Remove a handler for a given tenant from this handler.

request() - Method in interface io.vertx.ext.web.RoutingContext

RequestBody - Interface in io.vertx.ext.web

reroute(HttpMethod, String) - Method in interface io.vertx.ext.web.RoutingContext

Restarts the current router with a new method and path.

reroute(String) - Method in interface io.vertx.ext.web.RoutingContext

Restarts the current router with a new path and reusing the original method.

respond(Function<RoutingContext, Future<T>>) - Method in interface io.vertx.ext.web.Route

Append a function request handler to the route handlers list.

response() - Method in interface io.vertx.ext.web.RoutingContext

ResponseContentTypeHandler - Interface in io.vertx.ext.web.handler

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

ResponseTimeHandler - Interface in io.vertx.ext.web.handler

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

restore() - Method in interface io.vertx.ext.web.UserContext

Undo a previous call to a impersonation.

restore(String) - Method in interface io.vertx.ext.web.UserContext

Undo a previous call to an impersonation.

resultMapper(Function<CheckResult, Future<CheckResult>>) - Method in interface io.vertx.ext.web.healthchecks.HealthCheckHandler

Sets a function which will be invoked before the CheckResult gets written to clients.

resume() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

retryTimeout() - Method in interface io.vertx.ext.web.sstore.SessionStore

The retry timeout value in milli seconds used by the session handler when it retrieves a value from the store.

ROOT - io.vertx.ext.web.handler.FileSystemAccess

Access to the full file system, starting at "/", Limited by the operating systems permission for the user running the app.

route() - Method in interface io.vertx.ext.web.Router

Add a route with no matching criteria, i.e. it matches all requests or failures.

route(HttpMethod, String) - Method in interface io.vertx.ext.web.Router

Add a route that matches the specified HTTP method and path

route(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches the specified path

Route - Interface in io.vertx.ext.web

A route is a holder for a set of criteria which determine whether an HTTP request or failure should be routed to a handler.

router(Vertx) - Static method in interface io.vertx.ext.web.Router

Create a router

Router - Interface in io.vertx.ext.web

A router receives request from an HttpServer and routes it to the first matching Route that it contains.

routeWithRegex(HttpMethod, String) - Method in interface io.vertx.ext.web.Router

Add a route that matches the specified HTTP method and path regex

routeWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches the specified path regex

routingContext() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

routingContext() - Method in interface io.vertx.ext.web.WebServerRequest

RoutingContext - Interface in io.vertx.ext.web

Represents the context for the handling of a request in Vert.x-Web.

S

SAMEORIGIN - Static variable in interface io.vertx.ext.web.handler.XFrameHandler

The page can only be displayed in a frame on the same origin as the page itself.

scopeDelimiter(String) - Method in interface io.vertx.ext.web.handler.JWTAuthHandler

Set the scope delimiter.

SecurityAuditLoggerHandler - Interface in io.vertx.ext.web.handler

A handler that logs security audit events.

SecurityPolicyHandler - Interface in io.vertx.ext.web.handler

Base security policy interface for handlers that provide HTTP security related headers.

session() - Method in interface io.vertx.ext.web.RoutingContext

Get the session.

Session - Interface in io.vertx.ext.web

Represents a browser session.

SessionHandler - Interface in io.vertx.ext.web.handler

A handler that maintains a Session for each browser session.

SessionStore - Interface in io.vertx.ext.web.sstore

A session store is used to store sessions for an Vert.x-Web web app

setAcceptableContentType(String) - Method in interface io.vertx.ext.web.RoutingContext

Set the acceptable content type.

setAccessed() - Method in interface io.vertx.ext.web.Session

Mark the session as being accessed.

setAccessed() - Method in class io.vertx.ext.web.sstore.AbstractSession

setAlwaysAsyncFS(boolean) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set whether async filesystem access should always be used

setBodyLimit(long) - Method in interface io.vertx.ext.web.handler.BodyHandler

Set the maximum body size in bytes, -1 means no limit.

setCacheEntryTimeout(long) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set the server cache entry timeout when caching is enabled

setCachingEnabled(boolean) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set whether cache header handling is enabled

setCookieHttpOnly(boolean) - Method in interface io.vertx.ext.web.handler.CSRFHandler

Set the cookie httpOnly attribute.

setCookieHttpOnlyFlag(boolean) - Method in interface io.vertx.ext.web.handler.SessionHandler

Sets whether the 'HttpOnly' flag should be set for the session cookie.

setCookieless(boolean) - Method in interface io.vertx.ext.web.handler.SessionHandler

Use sessions based on url paths instead of cookies.

setCookieMaxAge(long) - Method in interface io.vertx.ext.web.handler.SessionHandler

Set a Cookie max-age to the session cookie.

setCookieName(String) - Method in interface io.vertx.ext.web.handler.CSRFHandler

Set the cookie name.

setCookiePath(String) - Method in interface io.vertx.ext.web.handler.CSRFHandler

Set the cookie path.

setCookieSameSite(CookieSameSite) - Method in interface io.vertx.ext.web.handler.SessionHandler

Set the session cookie SameSite policy to use.

setCookieSecure(boolean) - Method in interface io.vertx.ext.web.handler.CSRFHandler

Sets the cookie secure flag.

setCookieSecureFlag(boolean) - Method in interface io.vertx.ext.web.handler.SessionHandler

Sets whether the 'secure' flag should be set for the session cookie.

setData(JsonObject) - Method in class io.vertx.ext.web.sstore.AbstractSession

setData(Map<String, Object>) - Method in class io.vertx.ext.web.sstore.AbstractSession

setDefaultContentEncoding(String) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set the default content encoding for text related files.

setDeleteUploadedFilesOnEnd(boolean) - Method in interface io.vertx.ext.web.handler.BodyHandler

Set whether uploaded files should be removed after handling the request.

setDirective(String, String) - Method in interface io.vertx.ext.web.handler.CSPHandler

Sets a single directive entry to the handler.

setDirectLoggedInOKURL(String) - Method in interface io.vertx.ext.web.handler.FormLoginHandler

Set the url to redirect to if the user logs in directly at the url of the form login handler without being redirected here first

setDirectoryListing(boolean) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set whether directory listing is enabled

setDirectoryTemplate(String) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set the directory template to be used when directory listing

setEnableFSTuning(boolean) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set whether async/sync filesystem tuning should enabled

setEnableRangeSupport(boolean) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set whether range requests (resumable downloads; media streaming) should be enabled.

setExtensionTarget(String) - Method in class io.vertx.ext.web.Http2PushMapping

setFilePath(String) - Method in class io.vertx.ext.web.Http2PushMapping

setFilesReadOnly(boolean) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set whether files are read-only and will never change

setHandleFileUploads(boolean) - Method in interface io.vertx.ext.web.handler.BodyHandler

Set whether file uploads will be handled.

setHeaderName(String) - Method in interface io.vertx.ext.web.handler.CSRFHandler

Set the header name.

setHeartbeatInterval(long) - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

In order to keep proxies and load balancers from closing long running HTTP requests we need to pretend that the connection is active and send a heartbeat packet once in a while.

setHttp2PushMapping(List<Http2PushMapping>) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set the file mapping for http2push and link preload

setId(String) - Method in class io.vertx.ext.web.sstore.AbstractSession

setInboundPermitteds(List<PermittedOptions>) - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

setIncludeHidden(boolean) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set whether hidden files should be served

setIndexPage(String) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set the index page

setIndexTemplate(String) - Method in interface io.vertx.ext.web.handler.TemplateHandler

Set the index template

setInsertJSESSIONID(boolean) - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Whether to insert a JSESSIONID cookie so load-balancers ensure requests for a specific SockJS session are always routed to the correct server.

setLastAccessed(long) - Method in class io.vertx.ext.web.sstore.AbstractSession

setLazySession(boolean) - Method in interface io.vertx.ext.web.handler.SessionHandler

Use a lazy session creation mechanism.

setLibraryURL(String) - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Transports which don't support cross-domain communication natively use an iframe trick.

setLocalWriteHandler(boolean) - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Whether the writeHandler should be local only or cluster-wide.

setMaxAddressLength(int) - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

setMaxAgeSeconds(long) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set value for max age in caching headers

setMaxAvgServeTimeNs(long) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set the max serve time in ns, above which serves are considered slow

setMaxBytesStreaming(int) - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Most streaming transports save responses on the client side and don't free memory used by delivered messages.

setMaxCacheSize(int) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set the max cache size, when caching is enabled

setMaxHandlersPerSocket(int) - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

setMergeFormAttributes(boolean) - Method in interface io.vertx.ext.web.handler.BodyHandler

Set whether form attributes will be added to the request parameters.

setMinLength(int) - Method in interface io.vertx.ext.web.handler.SessionHandler

Set expected session id minimum length.

setNagHttps(boolean) - Method in interface io.vertx.ext.web.handler.CSRFHandler

Should the handler give warning messages if this handler is used in other than https protocols?

setNagHttps(boolean) - Method in interface io.vertx.ext.web.handler.SessionHandler

Set whether a nagging log warning should be written if the session handler is accessed over HTTP, not HTTPS

setName(String) - Method in interface io.vertx.ext.web.Route

Giving a name to a route will provide this name as metadata to requests matching this route.

setNoPush(boolean) - Method in class io.vertx.ext.web.Http2PushMapping

setOrigin(String) - Method in interface io.vertx.ext.web.handler.CSRFHandler

Set the origin for this server.

setOrigin(String) - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Set the origin to be verified before a websocket upgrade happens.

setOrigin(String) - Method in interface io.vertx.ext.web.handler.WebAuthn4JHandler

Set the Origin to be validated by the webauthn object.

setOutboundPermitteds(List<PermittedOptions>) - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

setPasswordParam(String) - Method in interface io.vertx.ext.web.handler.FormLoginHandler

Set the name of the form param used to submit the password

setPingTimeout(long) - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

setPreallocateBodyBuffer(boolean) - Method in interface io.vertx.ext.web.handler.BodyHandler

Pre-allocate the body buffer according to the value parsed from content-length header.

setPRNG(VertxContextPRNG) - Method in class io.vertx.ext.web.sstore.AbstractSession

setRawMessage(JsonObject) - Method in interface io.vertx.ext.web.handler.sockjs.BridgeEvent

Set the raw JSON message for the event.

setRegexGroupsNames(List<String>) - Method in interface io.vertx.ext.web.Route

When you add a new route with a regular expression, you can add named capture groups for parameters.

setRegisterWriteHandler(boolean) - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Whether a writeHandler should be registered on the EventBus.

setReplyTimeout(long) - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

setReportOnly(boolean) - Method in interface io.vertx.ext.web.handler.CSPHandler

To ease deployment, CSP can be deployed in report-only mode.

setReturnURLParam(String) - Method in interface io.vertx.ext.web.handler.FormLoginHandler

Set the name of the session attrioute used to specify the return url

setSendVaryHeader(boolean) - Method in interface io.vertx.ext.web.handler.StaticHandler

Set whether vary header should be sent with response.

setSessionCookieName(String) - Method in interface io.vertx.ext.web.handler.SessionHandler

Set the session cookie name

setSessionCookiePath(String) - Method in interface io.vertx.ext.web.handler.SessionHandler

Set the session cookie path

setSessionTimeout(long) - Method in interface io.vertx.ext.web.handler.SessionHandler

Set the session timeout

setSessionTimeout(long) - Method in class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Set the delay before the server sends a close event when a client receiving connection has not been seen for a while.

setSigningSecret(String) - Method in interface io.vertx.ext.web.handler.SessionHandler

Set signing secret for the session cookie.

setTimeout(long) - Method in interface io.vertx.ext.web.handler.CSRFHandler

Set the timeout for tokens generated by the handler, by default it uses the default from the session handler.

setTimeout(long) - Method in class io.vertx.ext.web.sstore.AbstractSession

setupCallback(Route) - Method in interface io.vertx.ext.web.handler.OAuth2AuthHandler

add the callback handler to a given route.

setupCallback(Route) - Method in interface io.vertx.ext.web.handler.OtpAuthHandler

Setup the required route where authenticators to submit the challenge response.

setupCallback(Route) - Method in interface io.vertx.ext.web.handler.WebAuthn4JHandler

The callback route to verify attestations and assertions.

setupCredentialsCreateCallback(Route) - Method in interface io.vertx.ext.web.handler.WebAuthn4JHandler

The callback route to create registration attestations.

setupCredentialsGetCallback(Route) - Method in interface io.vertx.ext.web.handler.WebAuthn4JHandler

The callback route to create login attestations.

setUploadsDirectory(String) - Method in interface io.vertx.ext.web.handler.BodyHandler

Set the uploads directory to use.

setupRegisterCallback(Route) - Method in interface io.vertx.ext.web.handler.OtpAuthHandler

Setup the optional route where authenticators are allowed to register.

setUser(RoutingContext, User) - Method in interface io.vertx.ext.web.handler.SessionHandler

Set the user for the session

setUsernameParam(String) - Method in interface io.vertx.ext.web.handler.FormLoginHandler

Set the name of the form param used to submit the username

setVersion(int) - Method in class io.vertx.ext.web.sstore.AbstractSession

setWriteQueueMaxSize(int) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

SHORT - io.vertx.ext.web.handler.LoggerFormat

remote-client - method uri version status content-length duration ms

SimpleAuthenticationHandler - Interface in io.vertx.ext.web.handler

A user customizable authentication handler.

size() - Method in interface io.vertx.ext.web.FileUpload

size() - Method in interface io.vertx.ext.web.sstore.SessionStore

Get the number of sessions in the store.

skipCompressionForMediaTypes(Set<String>) - Method in interface io.vertx.ext.web.handler.StaticHandler

Skip compression if the media type of the file to send is in the provided mediaTypes set.

skipCompressionForSuffixes(Set<String>) - Method in interface io.vertx.ext.web.handler.StaticHandler

Skip compression if the suffix of the file to send is in the provided fileSuffixes set.

socket() - Method in interface io.vertx.ext.web.handler.sockjs.BridgeEvent

Get the SockJSSocket instance corresponding to the event

socketHandler(Handler<SockJSSocket>) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSHandler

Set a SockJS socket handler.

SockJSBridgeOptions - Class in io.vertx.ext.web.handler.sockjs

Options for configuring the event bus bridge.

SockJSBridgeOptions() - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

Default constructor

SockJSBridgeOptions(JsonObject) - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

Constructor from JSON

SockJSBridgeOptions(SockJSBridgeOptions) - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

Copy constructor

SockJSBridgeOptionsConverter - Class in io.vertx.ext.web.handler.sockjs

Converter and mapper for SockJSBridgeOptions.

SockJSBridgeOptionsConverter() - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptionsConverter

SockJSHandler - Interface in io.vertx.ext.web.handler.sockjs

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

SockJSHandlerOptions - Class in io.vertx.ext.web.handler.sockjs

Options for configuring a SockJS handler

SockJSHandlerOptions() - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Default constructor.

SockJSHandlerOptions(JsonObject) - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Constructor to create options from JSON.

SockJSHandlerOptions(SockJSHandlerOptions) - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

Copy constructor.

SockJSSocket - Interface in io.vertx.ext.web.handler.sockjs

You interact with SockJS clients through instances of SockJS socket.

StaticHandler - Interface in io.vertx.ext.web.handler

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

statusCode() - Method in interface io.vertx.ext.web.RoutingContext

If the context is being routed to failure handlers after a failure has been triggered by calling RoutingContext.fail(int) then this will return that status code.

subComponent() - Method in interface io.vertx.ext.web.MIMEHeader

Gets the parsed subcomponent part of the MIME.

subRouter(Router) - Method in interface io.vertx.ext.web.Route

Use a (sub) Router as a handler.

subtag() - Method in interface io.vertx.ext.web.LanguageHeader

The subtag of the language as specified by rfc7231#section-3.1.3.1.
Equivalent to subtag(1)

subtag(int) - Method in interface io.vertx.ext.web.LanguageHeader

A subtag of this language header.
+ info: rfc7231#section-3.1.3.1

subtagCount() - Method in interface io.vertx.ext.web.LanguageHeader

T

tag() - Method in interface io.vertx.ext.web.LanguageHeader

The tag of the language as specified by rfc7231#section-3.1.3.1.
Equivalent to subtag(0)

TemplateHandler - Interface in io.vertx.ext.web.handler

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

TENANT - Static variable in interface io.vertx.ext.web.handler.MultiTenantHandler

The default key used to identify a tenant in the context data.

timeout() - Method in interface io.vertx.ext.web.Session

timeout() - Method in class io.vertx.ext.web.sstore.AbstractSession

TimeoutHandler - Interface in io.vertx.ext.web.handler

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

TINY - io.vertx.ext.web.handler.LoggerFormat

method uri status - content-length duration

toJson() - Method in class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions

toJson() - Method in class io.vertx.ext.web.Http2PushMapping

tokenExtractor(Function<String, Future<String>>) - Method in interface io.vertx.ext.web.handler.APIKeyHandler

Transform from user's token format to the AuthenticationHandler's format.

trace() - Method in interface io.vertx.ext.web.Router

Add a route that matches any HTTP TRACE request

trace(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP TRACE request and the specified path

traceWithRegex(String) - Method in interface io.vertx.ext.web.Router

Add a route that matches a HTTP TRACE request and the specified path regex

Transport - Enum in io.vertx.ext.web.handler.sockjs

The available SockJS transports

U

unregister(String) - Method in interface io.vertx.ext.web.healthchecks.HealthCheckHandler

Unregisters a procedure.

uploadedFileName() - Method in interface io.vertx.ext.web.FileUpload

uri() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

Return the URI corresponding to the last request for this socket or the websocket handshake

useNormalizedPath(boolean) - Method in interface io.vertx.ext.web.Route

If true then the normalized request path will be used when routing (e.g. removing duplicate /) Default is true

user() - Method in interface io.vertx.ext.web.RoutingContext

Get the authenticated user (if any).

userContext() - Method in interface io.vertx.ext.web.RoutingContext

Control the user associated with this request.

UserContext - Interface in io.vertx.ext.web

A web user is extended user coupled to the context and is used to perform verifications and actions on behalf of the user.

V

value() - Method in interface io.vertx.ext.web.ParsedHeaderValue

Holds the unparsed value of the header.
For the most part, this is the content before the semi-colon (";")

value() - Method in interface io.vertx.ext.web.Session

The short representation of the session to be added to the session cookie.

valueOf(String) - Static method in enum io.vertx.ext.web.AllowForwardHeaders

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.vertx.ext.web.handler.FileSystemAccess

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.vertx.ext.web.handler.LoggerFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.vertx.ext.web.handler.sockjs.Transport

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.vertx.ext.web.AllowForwardHeaders

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.vertx.ext.web.handler.FileSystemAccess

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.vertx.ext.web.handler.LoggerFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.vertx.ext.web.handler.sockjs.Transport

Returns an array containing the constants of this enum type, in the order they are declared.

variableConsumer(BiConsumer<RoutingContext, AuthorizationContext>) - Method in interface io.vertx.ext.web.handler.AuthorizationHandler

Provide a simple handler to extract needed variables.

verifyUrl(String) - Method in interface io.vertx.ext.web.handler.OtpAuthHandler

Specify the URL where requests are to be redirected when a user is already known in the request.

version() - Method in class io.vertx.ext.web.sstore.AbstractSession

vertx() - Method in interface io.vertx.ext.web.RoutingContext

virtualHost(String) - Method in interface io.vertx.ext.web.Route

Add a virtual host filter for this route.

W

WebAuthn4JHandler - Interface in io.vertx.ext.web.handler

An auth handler that provides FIDO2 WebAuthN Relay Party support.

WebServerRequest - Interface in io.vertx.ext.web

Extends to access the routing context associated with the request.

webSession() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

WEBSOCKET - io.vertx.ext.web.handler.sockjs.Transport

rfc 6455

webUser() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

weight() - Method in interface io.vertx.ext.web.ParsedHeaderValue

Holds the weight specified in the "q" parameter of the header.
If the parameter is not specified, 1.0 is assumed according to rfc7231

weightedOrder() - Method in interface io.vertx.ext.web.ParsedHeaderValue

An integer that represents the absolute order position of this header

withScope(String) - Method in interface io.vertx.ext.web.handler.JWTAuthHandler

Return a new instance with the internal state copied from the caller but the scopes to be requested during a token request are unique to the instance.

withScope(String) - Method in interface io.vertx.ext.web.handler.OAuth2AuthHandler

Return a new instance with the internal state copied from the caller but the scopes to be requested during a token request are unique to the instance.

withScopes(List<String>) - Method in interface io.vertx.ext.web.handler.JWTAuthHandler

Return a new instance with the internal state copied from the caller but the scopes to be requested during a token request are unique to the instance.

withScopes(List<String>) - Method in interface io.vertx.ext.web.handler.OAuth2AuthHandler

Return a new instance with the internal state copied from the caller but the scopes to be requested during a token request are unique to the instance.

write(Buffer) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

write(String) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

Write a String to the socket, encoded in UTF-8.

writeDataToBuffer(Buffer) - Method in class io.vertx.ext.web.sstore.AbstractSession

writeHandlerID() - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket

When a SockJSSocket is created it can register an event handler with the event bus, the ID of that handler is given by writeHandlerID.

X

X_FORWARD - io.vertx.ext.web.AllowForwardHeaders

Only process the non standard but widely used X-Forward-* headers.

XFrameHandler - Interface in io.vertx.ext.web.handler

The X-Frame-Options HTTP response header can be used to indicate whether or not a browser should be allowed to render a page in a <frame>, <iframe>, <embed> or <object>.

XHR - io.vertx.ext.web.handler.sockjs.Transport

Long-polling using cross domain XHR

A B C D E F G H I J L M N O P Q R S T U V W X
All Classes All Packages