new RoutingContext()
Represents the context for the handling of a request in Vert.x-Web.
A new instance is created for each HTTP request that is received in the
- Source:
Methods
acceptableLocales() → {Array.<Locale>}
Returns the locales for the current request. The locales are determined from the `accept-languages` header and
sorted on quality.
When 2 or more entries have the same quality then the order used to return the best match is based on the lowest
index on the original list. For example if a user has en-US and en-GB with same quality and this order the best
match will be en-US because it was declared as first entry by the client.
- Source:
Returns:
the best matched locale for the request
-
Type
-
Array.<Locale>
addBodyEndHandler(handler) → {number}
Add a handler that will be called just before the response body has been completely written.
This gives you a hook where you can write any extra data to the response before it has ended when it will be too late.
Parameters:
Name |
Type |
Description |
handler |
function
|
the handler |
- Source:
Returns:
the id of the handler. This can be used if you later want to remove the handler.
-
Type
-
number
addCookie(cookie) → {RoutingContext}
Add a cookie. This will be sent back to the client in the response. The context must have first been routed
to a CookieHandler for this to work.
Parameters:
Name |
Type |
Description |
cookie |
Cookie
|
the cookie |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
RoutingContext
addHeadersEndHandler(handler) → {number}
Add a handler that will be called just before headers are written to the response. This gives you a hook where
you can write any extra headers before the response has been written when it will be too late.
Parameters:
Name |
Type |
Description |
handler |
function
|
the handler |
- Source:
Returns:
the id of the handler. This can be used if you later want to remove the handler.
-
Type
-
number
clearUser()
Clear the current user object in the context. This usually is used for implementing a log out feature, since the
current user is unbounded from the routing context.
- Source:
cookieCount() → {number}
- Source:
Returns:
cookies() → {Array.<Cookie>}
- Source:
Returns:
currentRoute() → {Route}
- Source:
Returns:
fail(throwable)
Fail the context with the specified throwable.
This will cause the router to route the context to any matching failure handlers for the request. If no failure handlers
match a default failure response with status code 500 will be sent.
Parameters:
Name |
Type |
Description |
throwable |
todo
|
a throwable representing the failure |
- Source:
failed() → {boolean}
- Source:
Returns:
failure() → {todo}
If the context is being routed to failure handlers after a failure has been triggered by calling
RoutingContext#fail then this will return that throwable. It can be used by failure handlers to render a response,
e.g. create a failure response page.
- Source:
Returns:
the throwable used when signalling failure
-
Type
-
todo
fileUploads() → {Array.<FileUpload>}
- Source:
Returns:
get(key) → {Object}
Get some data from the context. The data is available in any handlers that receive the context.
Parameters:
Name |
Type |
Description |
key |
string
|
the key for the data |
- Source:
Returns:
the data
-
Type
-
Object
getAcceptableContentType() → {string}
If the route specifies produces matches, e.g. produces `text/html` and `text/plain`, and the `accept` header
matches one or more of these then this returns the most acceptable match.
- Source:
Returns:
the most acceptable content type.
-
Type
-
string
getBody() → {Buffer}
- Source:
Returns:
getBodyAsJson() → {Object}
- Source:
Returns:
getBodyAsJsonArray() → {todo}
- Source:
Returns:
getBodyAsString(encoding) → {string}
Get the entire HTTP request body as a string, assuming the specified encoding. The context must have first been routed to a
BodyHandler for this to be populated.
Parameters:
Name |
Type |
Description |
encoding |
string
|
the encoding, e.g. "UTF-16" |
- Source:
Returns:
the body
-
Type
-
string
getCookie(name) → {Cookie}
Get the cookie with the specified name. The context must have first been routed to a CookieHandler
for this to work.
Parameters:
Name |
Type |
Description |
name |
string
|
the cookie name |
- Source:
Returns:
the cookie
-
Type
-
Cookie
mountPoint() → {string}
- Source:
Returns:
next()
Tell the router to route this context to the next matching route (if any).
This method, if called, does not need to be called during the execution of the handler, it can be called
some arbitrary time later, if required.
If next is not called for a handler then the handler should make sure it ends the response or no response
will be sent.
- Source:
normalisedPath() → {string}
Return the normalised path for the request.
The normalised path is where the URI path has been decoded, i.e. any unicode or other illegal URL characters that
were encoded in the original URL with `%` will be returned to their original form. E.g. `%20` will revert to a space.
Also `+` reverts to a space in a query.
The normalised path will also not contain any `..` character sequences to prevent resources being accessed outside
of the permitted area.
It's recommended to always use the normalised path as opposed to
if accessing server resources requested by a client.
- Source:
Returns:
the normalised path
-
Type
-
string
pathParam(name) → {string}
Gets the value of a single path parameter
Parameters:
Name |
Type |
Description |
name |
string
|
the name of parameter as defined in path declaration |
- Source:
Returns:
the actual value of the parameter or null if it doesn't exist
-
Type
-
string
pathParams() → {Array.<string>}
Returns a map of named parameters as defined in path declaration with their actual values
- Source:
Returns:
the map of named parameters
-
Type
-
Array.<string>
preferredLocale() → {Locale}
Helper to return the user preferred locale. It is the same action as returning the first element of the acceptable
locales.
- Source:
Returns:
the users preferred locale.
-
Type
-
Locale
put(key, obj) → {RoutingContext}
Put some arbitrary data in the context. This will be available in any handlers that receive the context.
Parameters:
Name |
Type |
Description |
key |
string
|
the key for the data |
obj |
Object
|
the data |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
RoutingContext
removeBodyEndHandler(handlerID) → {boolean}
Remove a body end handler
Parameters:
Name |
Type |
Description |
handlerID |
number
|
the id as returned from RoutingContext#addBodyEndHandler. |
- Source:
Returns:
true if the handler existed and was removed, false otherwise
-
Type
-
boolean
removeCookie(name) → {Cookie}
Remove a cookie. The context must have first been routed to a CookieHandler
for this to work.
Parameters:
Name |
Type |
Description |
name |
string
|
the name of the cookie |
- Source:
Returns:
the cookie, if it existed, or null
-
Type
-
Cookie
removeHeadersEndHandler(handlerID) → {boolean}
Remove a headers end handler
Parameters:
Name |
Type |
Description |
handlerID |
number
|
the id as returned from RoutingContext#addHeadersEndHandler. |
- Source:
Returns:
true if the handler existed and was removed, false otherwise
-
Type
-
boolean
request() → {HttpServerRequest}
- Source:
Returns:
-
the HTTP request object
-
-
Type
-
HttpServerRequest
reroute(method, path)
Restarts the current router with a new method and path. All path parameters are then parsed and available on the
params list.
Parameters:
Name |
Type |
Description |
method |
Object
|
the new http request |
path |
string
|
the new http path. |
- Source:
response() → {HttpServerResponse}
- Source:
Returns:
-
the HTTP response object
-
-
Type
-
HttpServerResponse
session() → {Session}
Get the session. The context must have first been routed to a SessionHandler
for this to be populated.
Sessions live for a browser session, and are maintained by session cookies.
- Source:
Returns:
the session.
-
Type
-
Session
setAcceptableContentType(contentType)
Set the acceptable content type. Used by
Parameters:
Name |
Type |
Description |
contentType |
string
|
the content type |
- Source:
setBody(body)
Set the body. Used by the BodyHandler. You will not normally call this method.
Parameters:
Name |
Type |
Description |
body |
Buffer
|
the body |
- Source:
setSession(session)
Set the session. Used by the SessionHandler. You will not normally call this method.
Parameters:
Name |
Type |
Description |
session |
Session
|
the session |
- Source:
setUser(user)
Set the user. Usually used by auth handlers to inject a User. You will not normally call this method.
Parameters:
Name |
Type |
Description |
user |
User
|
the user |
- Source:
statusCode() → {number}
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. It can be used by failure handlers to render a response,
e.g. create a failure response page.
When the status code has not been set yet (it is undefined) its value will be -1.
- Source:
Returns:
the status code used when signalling failure
-
Type
-
number
user() → {User}
Get the authenticated user (if any). This will usually be injected by an auth handler if authentication if successful.
- Source:
Returns:
the user, or null if the current user is not authenticated.
-
Type
-
User
vertx() → {Vertx}
- Source:
Returns: