- 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.
- addAuthorities(Set<String>) - Method in interface io.vertx.ext.web.handler.AuthHandler
-
- addAuthority(String) - Method in interface io.vertx.ext.web.handler.AuthHandler
-
- 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.
- addCookie(Cookie) - Method in interface io.vertx.ext.web.RoutingContext
-
Add a cookie.
- 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.
- addEndHandler() - 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.
- 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.
- 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.
- 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.
- attachment(String) - Method in interface io.vertx.ext.web.RoutingContext
-
Set Content-Disposition get to "attachment" with optional filename
mime type.
- authenticateHeader(RoutingContext) - Method in interface io.vertx.ext.web.handler.AuthenticationHandler
-
Returns
- AuthenticationHandler - Interface in io.vertx.ext.web.handler
-
Base interface for auth handlers.
- AuthHandler - Interface in io.vertx.ext.web.handler
-
- AuthorizationHandler - Interface in io.vertx.ext.web.handler
-
Base interface for authorization handlers that provide authorization support.
- authorize(User, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.web.handler.AuthHandler
-
- authorize(User) - Method in interface io.vertx.ext.web.handler.AuthHandler
-
- cancel() - Method in interface io.vertx.ext.web.FileUpload
-
Try to cancel the file upload.
- 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(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.web.sstore.SessionStore
-
Remove all sessions from the store.
- clear() - Method in interface io.vertx.ext.web.sstore.SessionStore
-
- 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(int, String) - Method in interface io.vertx.ext.web.handler.sockjs.SockJSSocket
-
Close it giving a status code and reason.
- 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.
- 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
-
- cookieCount() - Method in interface io.vertx.ext.web.RoutingContext
-
- cookieMap() - 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.
- crc() - Method in class io.vertx.ext.web.sstore.AbstractSession
-
- create(Authorization) - Static method in interface io.vertx.ext.web.handler.AuthorizationHandler
-
create the 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(AuthenticationProvider) - Static method in interface io.vertx.ext.web.handler.BasicAuthHandler
-
Create a basic auth handler
- create(AuthenticationProvider, 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(boolean) - Static method in interface io.vertx.ext.web.handler.BodyHandler
-
Create a body handler setting if it should handle file uploads
- 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.ChainAuthHandler
-
- create(String) - Static method in interface io.vertx.ext.web.handler.CorsHandler
-
Create a CORS handler using a regular expression to match origins.
- 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(Vertx, String) - Static method in interface io.vertx.ext.web.handler.CSRFHandler
-
Instantiate a new CSRFHandlerImpl with a secret
- 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) - Static method in interface io.vertx.ext.web.handler.ErrorHandler
-
Create an error handler using defaults
- create(Vertx, String, boolean) - Static method in interface io.vertx.ext.web.handler.ErrorHandler
-
Create an error handler
- create(Vertx, boolean) - 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.ErrorHandler
-
Create an error handler
- create(Vertx) - Static method in interface io.vertx.ext.web.handler.FaviconHandler
-
Create a handler with defaults
- 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, 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, long) - Static method in interface io.vertx.ext.web.handler.FaviconHandler
-
Create a handler with the specified max cache time
- create(AuthenticationProvider) - Static method in interface io.vertx.ext.web.handler.FormLoginHandler
-
Create a handler
- create(AuthenticationProvider, String, String, String, String) - Static method in interface io.vertx.ext.web.handler.FormLoginHandler
-
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(boolean) - Static method in interface io.vertx.ext.web.handler.HSTSHandler
-
Creates a new instance that shall consider the configuration for sub domains.
- 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(JWTAuth) - 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() - Static method in interface io.vertx.ext.web.handler.MethodOverrideHandler
-
Create a X-HTTP-METHOD-OVERRIDE handler with safe downgrade of methods
- create(boolean) - Static method in interface io.vertx.ext.web.handler.MethodOverrideHandler
-
Create a X-HTTP-METHOD-OVERRIDE handler
- 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(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.
- create(Vertx, OAuth2Auth, String) - Static method in interface io.vertx.ext.web.handler.OAuth2AuthHandler
-
Create a OAuth2 auth handler with host pinning
- create(Vertx, OAuth2Auth) - Static method in interface io.vertx.ext.web.handler.OAuth2AuthHandler
-
Create a OAuth2 auth handler without host pinning.
- 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.RedirectAuthHandler
-
Create a handler
- create(AuthenticationProvider, 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(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(WebAuthn) - Static method in interface io.vertx.ext.web.handler.WebAuthnHandler
-
Create a WebAuthN auth handler.
- 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
- create(Vertx) - Static method in interface io.vertx.ext.web.sstore.SessionStore
-
Create a Session store given a backend and configuration JSON.
- create(Vertx, JsonObject) - Static method in interface io.vertx.ext.web.sstore.SessionStore
-
Create a Session store given a backend and configuration JSON.
- 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.
- 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
-
- customFormatter(Function<HttpServerRequest, String>) - Method in interface io.vertx.ext.web.handler.LoggerHandler
-
Set the custom formatter to be used by the handler.
- 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_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 = -1
means unlimited
- 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.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<Void>>) - Method in interface io.vertx.ext.web.sstore.SessionStore
-
Delete the session with the specified ID.
- delete(String) - Method in interface io.vertx.ext.web.sstore.SessionStore
-
- 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
- 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
-
- 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.
- parseCredentials(RoutingContext, Handler<AsyncResult<Credentials>>) - Method in interface io.vertx.ext.web.handler.AuthenticationHandler
-
Parses the credentials from the request into a JsonObject.
- parseCredentials(RoutingContext) - Method in interface io.vertx.ext.web.handler.AuthenticationHandler
-
- 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.
- 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
- postAuthentication(RoutingContext) - Method in interface io.vertx.ext.web.handler.AuthenticationHandler
-
This method is called to perform any post authentication tasks, such as redirects.
- 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.
- 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(String, Object) - Method in class io.vertx.ext.web.sstore.AbstractSession
-
- put(Session, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.web.sstore.SessionStore
-
Add a session with the specified ID.
- put(Session) - Method in interface io.vertx.ext.web.sstore.SessionStore
-
- 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
-
- putWithRegex(String) - Method in interface io.vertx.ext.web.Router
-
Add a route that matches a HTTP PUT request and the specified path regex
- rawValue() - Method in interface io.vertx.ext.web.ParsedHeaderValue
-
Contains the raw value that was received from the user agent
- redirect(String) - Method in interface io.vertx.ext.web.RoutingContext
-
Perform a 302 redirect to url
.
- redirect(String, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.web.RoutingContext
-
- 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
-
- regenerateId() - Method in class io.vertx.ext.web.sstore.AbstractSession
-
- 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
- removeCookie(String) - Method in interface io.vertx.ext.web.RoutingContext
-
Expire a cookie, notifying a User Agent to remove it from its cookie jar.
- removeCookie(String, boolean) - Method in interface io.vertx.ext.web.RoutingContext
-
Remove a cookie from the cookie set.
- 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
-
- 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.
- 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.
- 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.
- 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
-
- 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
- setAuthProvider(AuthProvider) - Method in interface io.vertx.ext.web.handler.SessionHandler
-
- 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 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.
- setCookieSecureFlag(boolean) - Method in interface io.vertx.ext.web.handler.SessionHandler
-
Sets whether the 'secure' flag should be set for the session cookie.
- setData(Map<String, Object>) - Method in class io.vertx.ext.web.sstore.AbstractSession
-
- setData(JsonObject) - 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 interface io.vertx.ext.web.handler.WebAuthnHandler
-
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.
- 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
- 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.
- 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.WebAuthnHandler
-
The callback route to verify attestations and assertions.
- setupCredentialsCreateCallback(Route) - Method in interface io.vertx.ext.web.handler.WebAuthnHandler
-
The callback route to create registration attestations.
- setupCredentialsGetCallback(Route) - Method in interface io.vertx.ext.web.handler.WebAuthnHandler
-
The callback route to create login attestations.
- 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
- setVersion(int) - Method in class io.vertx.ext.web.sstore.AbstractSession
-
- 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.
- size() - Method in interface io.vertx.ext.web.sstore.SessionStore
-
- 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(SockJSBridgeOptions) - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSBridgeOptions
-
Copy constructor
- 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
- SockJSBridgeOptionsConverter - Class in io.vertx.ext.web.handler.sockjs
-
- 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(SockJSHandlerOptions) - Constructor for class io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions
-
Copy constructor.
- 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.
- 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
-
- subtag(int) - Method in interface io.vertx.ext.web.LanguageHeader
-
- subtagCount() - Method in interface io.vertx.ext.web.LanguageHeader
-