public class RoutingContext extends Object
A new instance is created for each HTTP request that is received in the
Handler of the router.
The same instance is passed to any matching request or failure handlers during the routing of the request or failure.
The context provides access to the and and allows you to maintain arbitrary data that lives for the lifetime of the context. Contexts are discarded once they have been routed to the handler for the request.
The context also provides access to the Session, cookies and body for the request, given the correct handlers
in the application.
If you use the internal error handler
NOTE: This class has been automatically generated from theoriginal non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<RoutingContext> |
__TYPE_ARG |
| Constructor and Description |
|---|
RoutingContext(Object delegate) |
RoutingContext(RoutingContext delegate) |
| Modifier and Type | Method and Description |
|---|---|
List<LanguageHeader> |
acceptableLanguages()
Returns the languages for the current request.
|
int |
addBodyEndHandler(Handler<Void> handler)
Provides a handler that will be called after the last part of the body is written to the wire.
|
RoutingContext |
addCookie(Cookie cookie)
Deprecated.
|
int |
addEndHandler(Handler<AsyncResult<Void>> handler)
Add an end handler for the request/response context.
|
int |
addHeadersEndHandler(Handler<Void> handler)
Add a handler that will be called just before headers are written to the response.
|
RoutingContext |
attachment(String filename)
Set Content-Disposition get to "attachment" with optional
filename mime type. |
RequestBody |
body() |
void |
cancelAndCleanupFileUploads()
Cancel all unfinished file upload in progress and delete all uploaded files.
|
void |
clearUser()
Clear the current user object in the context.
|
int |
cookieCount()
Deprecated.
|
Map<String,Cookie> |
cookieMap()
Deprecated.
|
Route |
currentRoute() |
Map<String,Object> |
data() |
RoutingContext |
end()
|
RoutingContext |
end(Buffer buffer)
|
RoutingContext |
end(Buffer buffer,
Handler<AsyncResult<Void>> handler)
|
RoutingContext |
end(Handler<AsyncResult<Void>> handler)
|
RoutingContext |
end(String chunk)
|
RoutingContext |
end(String chunk,
Handler<AsyncResult<Void>> handler)
|
boolean |
equals(Object o) |
RoutingContext |
etag(String etag)
Set the ETag of a response.
|
void |
fail(int statusCode)
Fail the context with the specified status code.
|
void |
fail(int statusCode,
Throwable throwable)
Fail the context with the specified throwable and the specified the status code.
|
void |
fail(Throwable throwable)
Fail the context with the specified throwable and 500 status code.
|
boolean |
failed() |
Throwable |
failure()
If the context is being routed to failure handlers after a failure has been triggered by calling
fail(int) then this will return that throwable. |
List<FileUpload> |
fileUploads() |
<T> T |
get(String key)
Get some data from the context.
|
<T> T |
get(String key,
T defaultValue)
Get some data from the context.
|
String |
getAcceptableContentType()
If the route specifies produces matches, e.g.
|
Buffer |
getBody()
Deprecated.
|
JsonObject |
getBodyAsJson()
Deprecated.
|
JsonObject |
getBodyAsJson(int maxAllowedLength)
Deprecated.
|
JsonArray |
getBodyAsJsonArray()
Deprecated.
|
JsonArray |
getBodyAsJsonArray(int maxAllowedLength)
Deprecated.
|
String |
getBodyAsString()
Deprecated.
|
String |
getBodyAsString(String encoding)
Deprecated.
|
Cookie |
getCookie(String name)
Deprecated.
|
RoutingContext |
getDelegate() |
int |
hashCode() |
boolean |
is(String type)
Check if the incoming request contains the "Content-Type"
get field, and it contains the give mime `type`.
|
boolean |
isFresh()
Check if the request is fresh, aka
Last-Modified and/or the ETag
still match.
|
boolean |
isSessionAccessed()
Whether the
session() has been already called or not. |
RoutingContext |
json(Object json)
|
RoutingContext |
json(Object json,
Handler<AsyncResult<Void>> handler)
|
RoutingContext |
lastModified(java.time.Instant instant)
Set the Last-Modified date using a Instant.
|
RoutingContext |
lastModified(String instant)
Set the Last-Modified date using a String.
|
String |
mountPoint() |
static RoutingContext |
newInstance(RoutingContext arg) |
void |
next()
Tell the router to route this context to the next matching route (if any).
|
String |
normalisedPath()
Deprecated.
|
String |
normalizedPath()
Return the normalized path for the request.
|
ParsedHeaderValues |
parsedHeaders()
The headers:
Accept
Accept-Charset
Accept-Encoding
Accept-Language
Content-Type
Parsed into
ParsedHeaderValue |
String |
pathParam(String name)
Gets the value of a single path parameter
|
Map<String,String> |
pathParams()
Returns a map of named parameters as defined in path declaration with their actual values
|
LanguageHeader |
preferredLanguage()
Helper to return the user preferred language.
|
RoutingContext |
put(String key,
Object obj)
Put some arbitrary data in the context.
|
List<String> |
queryParam(String name)
Gets the value of a single query parameter.
|
MultiMap |
queryParams()
Returns a map of all query parameters inside the query string
The query parameters are lazily decoded: the decoding happens on the first time this method is called. |
MultiMap |
queryParams(Charset encoding)
Always decode the current query string with the given
encoding. |
RoutingContext |
redirect(String url)
|
RoutingContext |
redirect(String url,
Handler<AsyncResult<Void>> handler)
|
<T> T |
remove(String key)
Remove some data from the context.
|
boolean |
removeBodyEndHandler(int handlerID)
Remove a body end handler
|
Cookie |
removeCookie(String name)
Deprecated.
|
Cookie |
removeCookie(String name,
boolean invalidate)
Deprecated.
|
boolean |
removeEndHandler(int handlerID)
Remove an end handler
|
boolean |
removeHeadersEndHandler(int handlerID)
Remove a headers end handler
|
HttpServerRequest |
request() |
void |
reroute(HttpMethod method,
String path)
Restarts the current router with a new method and path.
|
void |
reroute(String path)
Restarts the current router with a new path and reusing the original method.
|
HttpServerResponse |
response() |
Single<Void> |
rxEnd()
|
Single<Void> |
rxEnd(Buffer buffer)
|
Single<Void> |
rxEnd(String chunk)
|
Single<Void> |
rxJson(Object json)
|
Single<Void> |
rxRedirect(String url)
|
Session |
session()
Get the session.
|
void |
setAcceptableContentType(String contentType)
Set the acceptable content type.
|
void |
setBody(Buffer body)
Deprecated.
|
void |
setSession(Session session)
Deprecated.
|
void |
setUser(User user)
Set the user.
|
int |
statusCode()
If the context is being routed to failure handlers after a failure has been triggered by calling
fail(int) then this will return that status code. |
String |
toString() |
User |
user()
Get the authenticated user (if any).
|
Vertx |
vertx() |
public static final io.vertx.lang.rx.TypeArg<RoutingContext> __TYPE_ARG
public RoutingContext(RoutingContext delegate)
public RoutingContext(Object delegate)
public RoutingContext getDelegate()
public HttpServerRequest request()
public HttpServerResponse response()
public void next()
If next is not called for a handler then the handler should make sure it ends the response or no response will be sent.
public void fail(int statusCode)
This will cause the router to route the context to any matching failure handlers for the request. If no failure handlers
match It will trigger the error handler matching the status code. You can define such error handler with
Router.errorHandler(int, io.vertx.core.Handler<io.vertx.rxjava.ext.web.RoutingContext>). If no error handler is not defined, It will send a default failure response with provided status code.
statusCode - the HTTP status codepublic void fail(Throwable throwable)
This will cause the router to route the context to any matching failure handlers for the request. If no failure handlers
match It will trigger the error handler matching the status code. You can define such error handler with
Router.errorHandler(int, io.vertx.core.Handler<io.vertx.rxjava.ext.web.RoutingContext>). If no error handler is not defined, It will send a default failure response with 500 status code.
throwable - a throwable representing the failurepublic void fail(int statusCode,
Throwable throwable)
This will cause the router to route the context to any matching failure handlers for the request. If no failure handlers
match It will trigger the error handler matching the status code. You can define such error handler with
Router.errorHandler(int, io.vertx.core.Handler<io.vertx.rxjava.ext.web.RoutingContext>). If no error handler is not defined, It will send a default failure response with provided status code.
statusCode - the HTTP status codethrowable - a throwable representing the failurepublic RoutingContext put(String key, Object obj)
key - the key for the dataobj - the datapublic <T> T get(String key)
key - the key for the datapublic <T> T get(String key, T defaultValue)
key - the key for the datadefaultValue - when the underlying data doesn't contain the key this will be the return value.public <T> T remove(String key)
key - the key for the datapublic Vertx vertx()
Router for this contextpublic String mountPoint()
public Route currentRoute()
@Deprecated public String normalisedPath()
normalizedPath() insteadpublic String normalizedPath()
The normalized 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 normalized 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 normalized path as opposed to if accessing server resources requested by a client.
@Deprecated public Cookie getCookie(String name)
name - the cookie name@Deprecated public RoutingContext addCookie(Cookie cookie)
cookie - the cookie@Deprecated public Cookie removeCookie(String name)
name - the name of the cookie@Deprecated public Cookie removeCookie(String name, boolean invalidate)
name - the name of the cookieinvalidate - @Deprecated public int cookieCount()
@Deprecated public Map<String,Cookie> cookieMap()
@Deprecated public String getBodyAsString()
BodyHandler for this to be populated.@Deprecated public String getBodyAsString(String encoding)
encoding - the encoding, e.g. "UTF-16"@Deprecated public JsonObject getBodyAsJson(int maxAllowedLength)
maxAllowedLength - if the current buffer length is greater than the limit an IllegalStateException is thrown. This can be used to avoid DDoS attacks on very long JSON payloads that could take over the CPU while attempting to parse the data.BodyHandler for this to be populated. null or the "null" JSON literal then null is returned.@Deprecated public JsonArray getBodyAsJsonArray(int maxAllowedLength)
maxAllowedLength - if the current buffer length is greater than the limit an IllegalStateException is thrown. This can be used to avoid DDoS attacks on very long JSON payloads that could take over the CPU while attempting to parse the data.BodyHandler for this to be populated. null or the "null" JSON literal then null is returned.@Deprecated public JsonObject getBodyAsJson()
BodyHandler for this to be populated. null or the "null" JSON literal then null is returned.@Deprecated public JsonArray getBodyAsJsonArray()
BodyHandler for this to be populated. null or the "null" JSON literal then null is returned.@Deprecated public Buffer getBody()
BodyHandler for this to be populated.public RequestBody body()
public List<FileUpload> fileUploads()
FileUpload (if any) for the request. The context must have first been routed to a BodyHandler for this to work.public void cancelAndCleanupFileUploads()
public Session session()
SessionHandler
for this to be populated.
Sessions live for a browser session, and are maintained by session cookies.public boolean isSessionAccessed()
session() has been already called or not. This is usually used by the
SessionHandler.public User user()
public Throwable failure()
fail(int) then this will return that throwable. It can be used by failure handlers to render a response,
e.g. create a failure response page.public int statusCode()
fail(int) 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.public String getAcceptableContentType()
public ParsedHeaderValues parsedHeaders()
ParsedHeaderValuepublic int addHeadersEndHandler(Handler<Void> handler)
handler - the handlerpublic boolean removeHeadersEndHandler(int handlerID)
handlerID - the id as returned from addHeadersEndHandler(io.vertx.core.Handler<java.lang.Void>).public int addBodyEndHandler(Handler<Void> handler)
handler - the handlerpublic boolean removeBodyEndHandler(int handlerID)
handlerID - the id as returned from addBodyEndHandler(io.vertx.core.Handler<java.lang.Void>).public int addEndHandler(Handler<AsyncResult<Void>> handler)
handler - the handler that will be called with either a success or failure result.public boolean removeEndHandler(int handlerID)
handlerID - the id as returned from addEndHandler(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>).public boolean failed()
@Deprecated public void setBody(Buffer body)
body - the body@Deprecated public void setSession(Session session)
session - the sessionpublic void setUser(User user)
user - the userpublic void clearUser()
public void setAcceptableContentType(String contentType)
contentType - the content typepublic void reroute(String path)
path - the new http path.public void reroute(HttpMethod method, String path)
method - the new http requestpath - the new http path.public List<LanguageHeader> acceptableLanguages()
Accept-Language
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.public LanguageHeader preferredLanguage()
public Map<String,String> pathParams()
public String pathParam(String name)
name - the name of parameter as defined in path declarationpublic MultiMap queryParams()
public List<String> queryParam(String name)
queryParams()name - The name of query parametername was foundpublic RoutingContext attachment(String filename)
filename mime type.filename - the filename for the attachmentpublic RoutingContext redirect(String url, Handler<AsyncResult<Void>> handler)
url - handler - public RoutingContext redirect(String url)
url - public RoutingContext json(Object json, Handler<AsyncResult<Void>> handler)
json - handler - public RoutingContext json(Object json)
json - public boolean is(String type)
type - content typepublic boolean isFresh()
public RoutingContext etag(String etag)
etag - the etag valuepublic RoutingContext lastModified(String instant)
instant - the last modified instantpublic RoutingContext end(String chunk, Handler<AsyncResult<Void>> handler)
chunk - handler - public RoutingContext end(String chunk)
chunk - public RoutingContext end(Buffer buffer, Handler<AsyncResult<Void>> handler)
buffer - handler - public RoutingContext end(Buffer buffer)
buffer - public RoutingContext end(Handler<AsyncResult<Void>> handler)
handler - public RoutingContext end()
public MultiMap queryParams(Charset encoding)
encoding. The decode result is never cached. Callers
to this method are expected to cache the result if needed. Usually users should use queryParams().
This method is only useful when the requests without content type (GET requests as an example) expect that
query params are in the ASCII format ISO-5559-1.encoding - a non null character set.public RoutingContext lastModified(java.time.Instant instant)
instant - the last modified instantpublic static RoutingContext newInstance(RoutingContext arg)
Copyright © 2024 Eclipse. All rights reserved.