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

A

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

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

This method is used to provide a request to the router.

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

Returns the languages for the current request.

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

Deprecated.

Use RoutingContext.acceptableLanguages() or RoutingContext.parsedHeaders().ParsedHeaderValues.acceptLanguage()

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

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

Add a set of required authorities for this auth handler

addAuthority(String) - Method in interface io.vertx.ext.web.handler.AuthHandler

Add a required authority for this auth handler

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.

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

Add a cookie.

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

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

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

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

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

Base interface for auth handlers.

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.

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

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

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

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

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

Like SockJSHandler.bridge(BridgeOptions) 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.

BridgeEventType - Enum in io.vertx.ext.web.handler.sockjs

Bridge Event Types.

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

Options for configuring the event bus bridge.

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

Copy constructor

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

Default constructor

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

Constructor from JSON

C

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

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

Remove all the routes from this router

clear(Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.web.sstore.SessionStore

Remove all sessions from the store

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

Clear the current user object in the context.

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

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.

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

Gets the parsed component part of the MIME.

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 - Interface in io.vertx.ext.web

Represents an HTTP Cookie.

cookie(String, String) - Static method in interface io.vertx.ext.web.Cookie

Create a new cookie

cookie(Cookie) - Static method in interface io.vertx.ext.web.Cookie

Create a new cookie from a Netty cookie

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

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

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

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

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.

country() - Method in interface io.vertx.ext.web.Locale

Deprecated.

Use LanguageHeader.subtag() instead

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

Create a basic auth handler

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

Create a basic auth handler, specifying realm

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

Create a body handler with defaults

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

Create a body handler and use the given upload directory.

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

Create a cookie handler

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

Create a CORS handler

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

Instantiate a new CSRFHandlerImpl with a secret

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

Create a digest auth handler

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

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

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

Create an error handler using defaults

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

Create an error handler

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

Create an error handler

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

Create an error handler

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

Create a handler with defaults

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

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

create(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(long) - Static method in interface io.vertx.ext.web.handler.FaviconHandler

Create a handler with the specified max cache time

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

Create a handler

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

Create a handler

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() - Static method in interface io.vertx.ext.web.handler.LoggerHandler

Create a handler with default format

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

Create a handler with he specified format

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

Create a handler with he specified format

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

Create a OAuth2 auth handler with host pinning

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

Create a handler

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

Create a handler

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

Create a handler

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

Create a response content type handler.

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

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

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

Create a handler

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

Create a session handler

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

Create a SockJS handler

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

Create a SockJS handler

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

Create a handler using defaults

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

Create a handler, specifying web-root

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

Create a handler, specifying web-root and a classloader used to load the resources.

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() - Static method in interface io.vertx.ext.web.handler.TimeoutHandler

Create a handler

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

Create a handler

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

Create a handler

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

Create a new handler

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

Create a handler

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

Deprecated.

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

Deprecated.

create(String, String) - Static method in interface io.vertx.ext.web.Locale

Deprecated.

create(String, String, String) - Static method in interface io.vertx.ext.web.Locale

Deprecated.

create(Vertx, String) - 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.ClusteredSessionStore

Create a session store.

The retry timeout value, configures how long the session handler will retry to get a session from the store when it is not found.

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

Create a session store

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

Create a session store.

The retry timeout value, configures how long the session handler will retry to get a session from the store when it is not found.

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

Create a session store

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

Create a session store

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

Create a session store

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

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

D

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

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

DEFAULT_ADDRESS - Static variable in class io.vertx.ext.web.handler.sockjs.PermittedOptions

The default permitted address : null.

DEFAULT_ADDRESS_REGEX - Static variable in class io.vertx.ext.web.handler.sockjs.PermittedOptions

The default permitted address regex : null.

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.

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_DISPLAY_EXCEPTION_DETAILS - Static variable in interface io.vertx.ext.web.handler.ErrorHandler

Should exception details be displayed by default?

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

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

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

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

Default path the user will be redirected to

DEFAULT_MATCH - Static variable in class io.vertx.ext.web.handler.sockjs.PermittedOptions

The default permitted match : null.

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

Default value for max address length = 200

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

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

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

Default value for ping timeout = 10000 ms

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_REPLY_TIMEOUT - Static variable in class io.vertx.ext.web.handler.sockjs.BridgeOptions

Default value for reply timeout = 30000

DEFAULT_REQUIRED_AUTHORITY - Static variable in class io.vertx.ext.web.handler.sockjs.PermittedOptions

The default permitted required authority : null.

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

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 form 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_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

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.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, Handler<AsyncResult<Boolean>>) - 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

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

Destroy the session

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.

encode() - Method in interface io.vertx.ext.web.Cookie

Encode the cookie to a string.

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

Call SockJSSocket.end().

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

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

A pretty error handler for rendering error pages.

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

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

Specify a handler for any unhandled exceptions on this router.

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(Throwable) - Method in interface io.vertx.ext.web.RoutingContext

Fail the context with the specified throwable.

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

Specify a failure handler for the route.

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

A handler that serves favicons.

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

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<T>, Collection<T>) - 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.

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

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

G

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

Add a route that matches any HTTP GET request

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, Handler<AsyncResult<Session>>) - Method in interface io.vertx.ext.web.sstore.SessionStore

Get the session with the specified ID

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

If the route specifies produces matches, e.g.

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

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

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

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

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

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

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

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

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

Get the cookie with the specified name.

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

getDomain() - Method in interface io.vertx.ext.web.Cookie

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

getInboundPermitteds() - Method in class io.vertx.ext.web.handler.sockjs.BridgeOptions

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

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

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

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

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

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

getOutboundPermitteds() - Method in class io.vertx.ext.web.handler.sockjs.BridgeOptions

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

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

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

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

Get the raw JSON message for the event.

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

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

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

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

getValue() - Method in interface io.vertx.ext.web.Cookie

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

Specify a request handler for the route.

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

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

I

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

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

Install SockJS test applications on a router - used when running the SockJS test suite

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

= Vert.x-Web :toc: left Vert.x-Web is a set of building blocks for building web applications with Vert.x.

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.sstore - package io.vertx.ext.web.sstore

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

isCachingEnabled() - Method in interface io.vertx.ext.web.templ.TemplateEngine

Returns true if the template engine caches template files.

isChanged() - Method in interface io.vertx.ext.web.Cookie

Has the cookie been changed? Changed cookies will be saved out in the response and sent to the browser.

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

isInsertJSESSIONID() - 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

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

J

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

An auth handler that provides JWT Authentication support.

L

language() - Method in interface io.vertx.ext.web.Locale

Deprecated.

Use LanguageHeader.tag() instead

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

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

Return the local address for this socket

Locale - Interface in io.vertx.ext.web

Deprecated.

Use LanguageHeader instead

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.

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

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

M

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

Set how long the browser should cache the information

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

Add an HTTP method for this route.

MIMEHeader - Interface in io.vertx.ext.web

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

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

Mount a sub router on this router

N

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

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

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

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

Return the normalised path for the request.

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

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.

P

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

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

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

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

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

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

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.

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

Deprecated.

Use RoutingContext.preferredLanguage() instead

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

Add a content type produced by this route.

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

Add a route that matches any HTTP PUT request

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(Session, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.web.sstore.SessionStore

Add a session with the specified ID

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

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

R

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

Contains the raw value that was received from the user agent

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.

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

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

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

Remove a body end handler

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

Remove a cookie.

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

Remove a headers end handler

render(RoutingContext, String, Handler<AsyncResult<Buffer>>) - Method in interface io.vertx.ext.web.templ.TemplateEngine

Deprecated.

use TemplateEngine.render(RoutingContext, String, String, Handler)

render(RoutingContext, String, String, Handler<AsyncResult<Buffer>>) - Method in interface io.vertx.ext.web.templ.TemplateEngine

Render the template

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

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

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

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

Restarts the current router with a new method and path.

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.

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.

A non positive value means there is no retry at all.

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.

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

Add a route with no matching criteria, i.e.

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

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.

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

Create a router

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 - Interface in io.vertx.ext.web

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

S

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.

setAddress(String) - Method in class io.vertx.ext.web.handler.sockjs.PermittedOptions

The exact address the message is being sent to.

setAddressRegex(String) - Method in class io.vertx.ext.web.handler.sockjs.PermittedOptions

A regular expression that will be matched against the address.

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

Enable/Disable access to the root of the filesystem

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

Set whether async filesystem access should always be used

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

Set the audience list

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

Set the body.

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

Set the maximum body size -1 means unlimited

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

setChanged(boolean) - Method in interface io.vertx.ext.web.Cookie

Set the cookie as being changed.

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

Sets whether the 'HttpOnly' flag should be set for 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.

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

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

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

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

setDomain(String) - Method in interface io.vertx.ext.web.Cookie

Sets the domain of this cookie

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.

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

Set whether files are read-only and will never change

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

setHttpOnly(boolean) - Method in interface io.vertx.ext.web.Cookie

Determines if this cookie is HTTP only.

setIgnoreExpiration(boolean) - Method in interface io.vertx.ext.web.handler.JWTAuthHandler

Set whether expiration is ignored

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

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

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

Set the issuer

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

setMatch(JsonObject) - Method in class io.vertx.ext.web.handler.sockjs.PermittedOptions

This allows you to allow messages based on their structure.

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

setMaxAge(long) - Method in interface io.vertx.ext.web.Cookie

Sets the maximum age of this cookie in seconds.

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

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

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

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

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

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

setPath(String) - Method in interface io.vertx.ext.web.Cookie

Sets the path of this cookie.

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

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

Get the raw JSON message for the event.

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

setRequiredAuthority(String) - Method in class io.vertx.ext.web.handler.sockjs.PermittedOptions

Declare a specific authority that user must have in order to allow messages

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

Set the body returned by the handler when the XSRF token is missing or invalid.

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

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

setSecure(boolean) - Method in interface io.vertx.ext.web.Cookie

Sets the security getStatus of this cookie

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

Set whether vary header should be sent with response.

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

Set the session.

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

Set the session cookie name

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

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.

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

add the callback handler to a given route.

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

Set the uploads directory to use

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

Set the user.

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

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

setValue(String) - Method in interface io.vertx.ext.web.Cookie

Sets the value of this cookie

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

Set the web root

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

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

size(Handler<AsyncResult<Integer>>) - Method in interface io.vertx.ext.web.sstore.SessionStore

Get the number of sessions in the store

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.

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(SockJSHandlerOptions) - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions

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

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

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.

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)

TemplateEngine - Interface in io.vertx.ext.web.templ

A template engine uses a specific template and the data in a routing context to render a resource into a buffer.

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.

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

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

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

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

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

U

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

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

If true then the normalised request path will be used when routing (e.g.

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

Get the authenticated user (if any).

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

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.

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 (";")

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

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

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.

variant() - Method in interface io.vertx.ext.web.Locale

Deprecated.

Use LanguageHeader.subtag(int) with value 2 instead

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

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

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

W

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

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

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.

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

When a SockJSSocket is created it automatically registers an event handler with the event bus, the ID of that handler is given by writeHandlerID.

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