- charSet() - Method in FileUpload
-
@return
- Returns:
- the charset of the upload
- clear() - Method in Router
-
Remove all the routes from this router
- clear(Handler<AsyncResult<Boolean>>) - Method in SessionStore
-
Remove all sessions from the store
- clearUser() - Method in RoutingContext
-
Clear the current user object in the context.
- close() - Method in SessionStore
-
Close the store
- close() - Method in SockJSSocket
-
Close it
- ClusteredSessionStore - Class in io.vertx.groovy.ext.web.sstore
A session store which stores sessions in a distributed map so they are available across the cluster.
- ClusteredSessionStore(Object) - Constructor in ClusteredSessionStore
-
- connect(String) - Method in Router
-
Add a route that matches a HTTP CONNECT request and the specified path
- connectWithRegex(String) - Method in Router
-
Add a route that matches a HTTP CONNECT request and the specified path regex
- consumes(String) - Method in Route
-
Add a content type consumed by this route.
- contentTransferEncoding() - Method in FileUpload
-
- Returns:
- the content transfer encoding of the upload - this describes how the upload was encoded in the form submission.
- contentType() - Method in FileUpload
-
@return
- Returns:
- the content type (MIME type) of the upload
- Cookie - Class in io.vertx.groovy.ext.web
Represents an HTTP Cookie.
- Cookie(Object) - Constructor in Cookie
-
- cookieCount() - Method in RoutingContext
-
- Returns:
- the number of cookies.
- CookieHandler - Class in io.vertx.groovy.ext.web.handler
A handler which decodes cookies from the request, makes them available in the
and writes them back in the response.
- CookieHandler(Object) - Constructor in CookieHandler
-
- cookies() - Method in RoutingContext
-
- Returns:
- a set of all the cookies.
- CorsHandler - Class in io.vertx.groovy.ext.web.handler
A handler which implements server side http://www.w3.org/TR/cors/[CORS] support for Vert.x-Web.
- CorsHandler(Object) - Constructor in CorsHandler
-
- country() - Method in Locale
-
Returns the country as reported by the HTTP client.
- create(AuthProvider, String) - Method in BasicAuthHandler
-
Create a basic auth handler, specifying realm
- create() - Method in BodyHandler
-
Create a body handler with defaults
- create(Vertx) - Method in ClusteredSessionStore
-
Create a session store
- create() - Method in CookieHandler
-
Create a cookie handler
- create(String) - Method in CorsHandler
-
Create a CORS handler
- create(String) - Method in CSRFHandler
-
Instantiate a new CSRFHandlerImpl with a secret
- create(String) - Method in ErrorHandler
-
Create an error handler
- create(long) - Method in FaviconHandler
-
Create a handler with the specified max cache time
- create(AuthProvider, String, String, String, String) - Method in FormLoginHandler
-
Create a handler
- create(AuthProvider, String) - Method in JWTAuthHandler
-
Create a JWT auth handler
- create(String, String, String) - Method in Locale
-
- create(Vertx, String, long) - Method in LocalSessionStore
-
Create a session store
- create(boolean, LoggerFormat) - Method in LoggerHandler
-
Create a handler with he specified format
- create(AuthProvider, String, String) - Method in RedirectAuthHandler
-
Create a handler
- create() - Method in ResponseTimeHandler
-
Create a handler
- create(SessionStore) - Method in SessionHandler
-
Create a session handler
- create(Vertx, Map<String, Object>) - Method in SockJSHandler
-
Create a SockJS handler
- create(String) - Method in StaticHandler
-
Create a handler, specifying web-root
- create(TemplateEngine, String, String) - Method in TemplateHandler
-
Create a handler
- create(long) - Method in TimeoutHandler
-
Create a handler
- create(AuthProvider) - Method in UserSessionHandler
-
Create a new handler
- create(String, Handler<RoutingContext>) - Method in VirtualHostHandler
-
Create a handler
- createSession(long) - Method in SessionStore
-
Create a new session
- CSRFHandler - Class in io.vertx.groovy.ext.web.handler
This handler adds a CSRF token to requests which mutate state.
- CSRFHandler(Object) - Constructor in CSRFHandler
-
- currentRoute() - Method in RoutingContext
-
- Returns:
- the current route this context is being routed through.
- Session - Class in io.vertx.groovy.ext.web
Represents a browser session.
- session() - Method in RoutingContext
-
Get the session.
- Session(Object) - Constructor in Session
-
- SessionHandler - Class in io.vertx.groovy.ext.web.handler
A handler that maintains a
Session for each browser session.
- SessionHandler(Object) - Constructor in SessionHandler
-
- SessionStore - Class in io.vertx.groovy.ext.web.sstore
A session store is used to store sessions for an Vert.x-Web web app
- SessionStore(Object) - Constructor in SessionStore
-
- setAcceptableContentType(String) - Method in RoutingContext
-
Set the acceptable content type.
- setAccessed() - Method in Session
-
Mark the session as being accessed.
- setAlwaysAsyncFS(boolean) - Method in StaticHandler
-
Set whether async filesystem access should always be used
- setAudience(List<String>) - Method in JWTAuthHandler
-
Set the audience list
- setBody(Buffer) - Method in RoutingContext
-
Set the body.
- setBodyLimit(long) - Method in BodyHandler
-
Set the maximum body size -1 means unlimited
- setCacheEntryTimeout(long) - Method in StaticHandler
-
Set the server cache entry timeout when caching is enabled
- setCachingEnabled(boolean) - Method in StaticHandler
-
Set whether cache header handling is enabled
- setChanged(boolean) - Method in Cookie
-
Set the cookie as being changed.
- setCookieHttpOnlyFlag(boolean) - Method in SessionHandler
-
Sets whether the 'HttpOnly' flag should be set for the session cookie.
- setCookieName(String) - Method in CSRFHandler
-
Set the cookie name.
- setCookieSecureFlag(boolean) - Method in SessionHandler
-
Sets whether the 'secure' flag should be set for the session cookie.
- setDirectLoggedInOKURL(String) - Method in 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 StaticHandler
-
Set whether directory listing is enabled
- setDirectoryTemplate(String) - Method in StaticHandler
-
Set the directory template to be used when directory listing
- setDomain(String) - Method in Cookie
-
Sets the domain of this cookie
- setEnableFSTuning(boolean) - Method in StaticHandler
-
Set whether async/sync filesystem tuning should enabled
- setEnableRangeSupport(boolean) - Method in StaticHandler
-
Set whether range requests (resumable downloads; media streaming) should be enabled.
- setFilesReadOnly(boolean) - Method in StaticHandler
-
Set whether files are read-only and will never change
- setHeaderName(String) - Method in CSRFHandler
-
Set the header name.
- setHttpOnly(boolean) - Method in Cookie
-
Determines if this cookie is HTTP only.
- setIgnoreExpiration(boolean) - Method in JWTAuthHandler
-
Set whether expiration is ignored
- setIncludeHidden(boolean) - Method in StaticHandler
-
Set whether hidden files should be served
- setIndexPage(String) - Method in StaticHandler
-
Set the index page
- setIssuer(String) - Method in JWTAuthHandler
-
Set the issuer
- setMaxAge(long) - Method in Cookie
-
Sets the maximum age of this cookie in seconds.
- setMaxAgeSeconds(long) - Method in StaticHandler
-
Set value for max age in caching headers
- setMaxAvgServeTimeNs(long) - Method in StaticHandler
-
Set the max serve time in ns, above which serves are considered slow
- setMaxCacheSize(int) - Method in StaticHandler
-
Set the max cache size, when caching is enabled
- setMergeFormAttributes(boolean) - Method in BodyHandler
-
Set whether form attributes will be added to the request parameters
- setNagHttps(boolean) - Method in CSRFHandler
-
Should the handler give warning messages if this handler is used in other than https protocols?
- setNagHttps(boolean) - Method in SessionHandler
-
Set whether a nagging log warning should be written if the session handler is accessed over HTTP, not
HTTPS
- setPasswordParam(String) - Method in FormLoginHandler
-
Set the name of the form param used to submit the password
- setPath(String) - Method in Cookie
-
Sets the path of this cookie.
- setReturnURLParam(String) - Method in FormLoginHandler
-
Set the name of the session attrioute used to specify the return url
- setSecure(boolean) - Method in Cookie
-
Sets the security getStatus of this cookie
- setSession(Session) - Method in RoutingContext
-
Set the session.
- setSessionCookieName(String) - Method in SessionHandler
-
Set the session cookie name
- setSessionTimeout(long) - Method in SessionHandler
-
Set the session timeout
- setTimeout(long) - Method in CSRFHandler
-
Set the timeout for tokens generated by the handler, by default it uses the default from the session handler.
- setUploadsDirectory(String) - Method in BodyHandler
-
Set the uploads directory to use
- setUser(User) - Method in RoutingContext
-
Set the user.
- setUsernameParam(String) - Method in FormLoginHandler
-
Set the name of the form param used to submit the username
- setValue(String) - Method in Cookie
-
Sets the value of this cookie
- setWebRoot(String) - Method in StaticHandler
-
Set the web root
- setWriteQueueMaxSize(int) - Method in SockJSSocket
-
- size() - Method in FileUpload
-
@return
- Returns:
- the size of the upload, in bytes
- size(Handler<AsyncResult<Integer>>) - Method in SessionStore
-
Get the number of sessions in the store
- socket() - Method in BridgeEvent
-
Get the SockJSSocket instance corresponding to the event
- socketHandler(Handler<SockJSSocket>) - Method in SockJSHandler
-
Set a SockJS socket handler.
- SockJSHandler - Class in io.vertx.groovy.ext.web.handler.sockjs
A handler that allows you to handle SockJS connections from clients.
- SockJSHandler(Object) - Constructor in SockJSHandler
-
- SockJSSocket - Class in io.vertx.groovy.ext.web.handler.sockjs
You interact with SockJS clients through instances of SockJS socket.
- SockJSSocket(Object) - Constructor in SockJSSocket
-
- StaticHandler - Class in io.vertx.groovy.ext.web.handler
A handler for serving static resources from the file system or classpath.
- StaticHandler(Object) - Constructor in StaticHandler
-
- statusCode() - Method in RoutingContext
-
If the context is being routed to failure handlers after a failure has been triggered by calling
RoutingContext.fail then this will return that status code.