io.vertx.rxjava.ext.web.RoutingContext Maven / Gradle / Ivy
/*
* Copyright 2014 Red Hat, Inc.
*
* Red Hat licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.vertx.rxjava.ext.web;
import rx.Observable;
import rx.Single;
import io.vertx.rx.java.RxHelper;
import io.vertx.rx.java.WriteStreamSubscriber;
import io.vertx.rx.java.SingleOnSubscribeAdapter;
import java.util.Map;
import java.util.Set;
import java.util.List;
import java.util.Iterator;
import java.util.function.Function;
import java.util.stream.Collectors;
import io.vertx.core.Handler;
import io.vertx.core.AsyncResult;
import io.vertx.core.json.JsonObject;
import io.vertx.core.json.JsonArray;
import io.vertx.lang.rx.RxGen;
import io.vertx.lang.rx.TypeArg;
import io.vertx.lang.rx.MappingIterator;
/**
* 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
* {@link io.vertx.core.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 {@link io.vertx.rxjava.ext.web.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 the {@link io.vertx.ext.web.RoutingContext original} non RX-ified interface using Vert.x codegen.
*/
@RxGen(io.vertx.ext.web.RoutingContext.class)
public class RoutingContext {
@Override
public String toString() {
return delegate.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
RoutingContext that = (RoutingContext) o;
return delegate.equals(that.delegate);
}
@Override
public int hashCode() {
return delegate.hashCode();
}
public static final TypeArg __TYPE_ARG = new TypeArg<>( obj -> new RoutingContext((io.vertx.ext.web.RoutingContext) obj),
RoutingContext::getDelegate
);
private final io.vertx.ext.web.RoutingContext delegate;
public RoutingContext(io.vertx.ext.web.RoutingContext delegate) {
this.delegate = delegate;
}
public RoutingContext(Object delegate) {
this.delegate = (io.vertx.ext.web.RoutingContext)delegate;
}
public io.vertx.ext.web.RoutingContext getDelegate() {
return delegate;
}
private static final TypeArg TYPE_ARG_0 = new TypeArg(o1 -> io.vertx.rxjava.ext.web.Cookie.newInstance((io.vertx.ext.web.Cookie)o1), o1 -> o1.getDelegate());
private static final TypeArg TYPE_ARG_1 = new TypeArg(o1 -> io.vertx.rxjava.ext.web.FileUpload.newInstance((io.vertx.ext.web.FileUpload)o1), o1 -> o1.getDelegate());
private static final TypeArg TYPE_ARG_2 = new TypeArg(o1 -> io.vertx.rxjava.ext.web.Locale.newInstance((io.vertx.ext.web.Locale)o1), o1 -> o1.getDelegate());
private static final TypeArg TYPE_ARG_3 = new TypeArg(o1 -> io.vertx.rxjava.ext.web.LanguageHeader.newInstance((io.vertx.ext.web.LanguageHeader)o1), o1 -> o1.getDelegate());
/**
* @return the HTTP request object
*/
public io.vertx.rxjava.core.http.HttpServerRequest request() {
if (cached_0 != null) {
return cached_0;
}
io.vertx.rxjava.core.http.HttpServerRequest ret = io.vertx.rxjava.core.http.HttpServerRequest.newInstance((io.vertx.core.http.HttpServerRequest)delegate.request());
cached_0 = ret;
return ret;
}
/**
* @return the HTTP response object
*/
public io.vertx.rxjava.core.http.HttpServerResponse response() {
if (cached_1 != null) {
return cached_1;
}
io.vertx.rxjava.core.http.HttpServerResponse ret = io.vertx.rxjava.core.http.HttpServerResponse.newInstance((io.vertx.core.http.HttpServerResponse)delegate.response());
cached_1 = ret;
return ret;
}
/**
* 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.
*/
public void next() {
delegate.next();
}
/**
* Fail the context with the specified status code.
*
* 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
* {@link io.vertx.rxjava.ext.web.Router#errorHandler}. If no error handler is not defined, It will send a default failure response with provided status code.
* @param statusCode the HTTP status code
*/
public void fail(int statusCode) {
delegate.fail(statusCode);
}
/**
* Fail the context with the specified throwable and 500 status code.
*
* 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
* {@link io.vertx.rxjava.ext.web.Router#errorHandler}. If no error handler is not defined, It will send a default failure response with 500 status code.
* @param throwable a throwable representing the failure
*/
public void fail(java.lang.Throwable throwable) {
delegate.fail(throwable);
}
/**
* Fail the context with the specified throwable and the specified the status code.
*
* 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
* {@link io.vertx.rxjava.ext.web.Router#errorHandler}. If no error handler is not defined, It will send a default failure response with provided status code.
* @param statusCode the HTTP status code
* @param throwable a throwable representing the failure
*/
public void fail(int statusCode, java.lang.Throwable throwable) {
delegate.fail(statusCode, throwable);
}
/**
* Put some arbitrary data in the context. This will be available in any handlers that receive the context.
* @param key the key for the data
* @param obj the data
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.ext.web.RoutingContext put(String key, java.lang.Object obj) {
delegate.put(key, obj);
return this;
}
/**
* Get some data from the context. The data is available in any handlers that receive the context.
* @param key the key for the data
* @return the data
*/
public T get(String key) {
T ret = (T) delegate.get(key);
return ret;
}
/**
* Remove some data from the context. The data is available in any handlers that receive the context.
* @param key the key for the data
* @return the previous data associated with the key
*/
public T remove(String key) {
T ret = (T) delegate.remove(key);
return ret;
}
/**
* @return the Vert.x instance associated to the initiating {@link io.vertx.rxjava.ext.web.Router} for this context
*/
public io.vertx.rxjava.core.Vertx vertx() {
if (cached_2 != null) {
return cached_2;
}
io.vertx.rxjava.core.Vertx ret = io.vertx.rxjava.core.Vertx.newInstance((io.vertx.core.Vertx)delegate.vertx());
cached_2 = ret;
return ret;
}
/**
* @return the mount point for this router. It will be null for a top level router. For a sub-router it will be the path at which the subrouter was mounted.
*/
public String mountPoint() {
String ret = delegate.mountPoint();
return ret;
}
/**
* @return the current route this context is being routed through.
*/
public io.vertx.rxjava.ext.web.Route currentRoute() {
io.vertx.rxjava.ext.web.Route ret = io.vertx.rxjava.ext.web.Route.newInstance((io.vertx.ext.web.Route)delegate.currentRoute());
return ret;
}
/**
* 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.
* @return the normalised path
*/
public String normalisedPath() {
String ret = delegate.normalisedPath();
return ret;
}
/**
* Get the cookie with the specified name.
* @param name the cookie name
* @return the cookie
*/
public io.vertx.rxjava.ext.web.Cookie getCookie(String name) {
io.vertx.rxjava.ext.web.Cookie ret = io.vertx.rxjava.ext.web.Cookie.newInstance((io.vertx.ext.web.Cookie)delegate.getCookie(name));
return ret;
}
/**
* Add a cookie. This will be sent back to the client in the response.
* @param cookie the cookie
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.ext.web.RoutingContext addCookie(io.vertx.rxjava.core.http.Cookie cookie) {
delegate.addCookie(cookie.getDelegate());
return this;
}
/**
* Expire a cookie, notifying a User Agent to remove it from its cookie jar.
* @param name the name of the cookie
* @return the cookie, if it existed, or null
*/
public io.vertx.rxjava.ext.web.Cookie removeCookie(String name) {
io.vertx.rxjava.ext.web.Cookie ret = io.vertx.rxjava.ext.web.Cookie.newInstance((io.vertx.ext.web.Cookie)delegate.removeCookie(name));
return ret;
}
/**
* Remove a cookie from the cookie set. If invalidate is true then it will expire a cookie, notifying a User Agent to
* remove it from its cookie jar.
* @param name the name of the cookie
* @param invalidate
* @return the cookie, if it existed, or null
*/
public io.vertx.rxjava.ext.web.Cookie removeCookie(String name, boolean invalidate) {
io.vertx.rxjava.ext.web.Cookie ret = io.vertx.rxjava.ext.web.Cookie.newInstance((io.vertx.ext.web.Cookie)delegate.removeCookie(name, invalidate));
return ret;
}
/**
* @return the number of cookies.
*/
public int cookieCount() {
int ret = delegate.cookieCount();
return ret;
}
/**
* @return a set of all the cookies.
*/
@Deprecated()
public Set cookies() {
Set ret = delegate.cookies().stream().map(elt -> io.vertx.rxjava.ext.web.Cookie.newInstance((io.vertx.ext.web.Cookie)elt)).collect(java.util.stream.Collectors.toSet());
return ret;
}
/**
* @return the entire HTTP request body as a string, assuming UTF-8 encoding. The context must have first been routed to a {@link io.vertx.rxjava.ext.web.handler.BodyHandler} for this to be populated.
*/
public String getBodyAsString() {
String ret = delegate.getBodyAsString();
return ret;
}
/**
* Get the entire HTTP request body as a string, assuming the specified encoding. The context must have first been routed to a
* {@link io.vertx.rxjava.ext.web.handler.BodyHandler} for this to be populated.
* @param encoding the encoding, e.g. "UTF-16"
* @return the body
*/
public String getBodyAsString(String encoding) {
String ret = delegate.getBodyAsString(encoding);
return ret;
}
/**
* @return Get the entire HTTP request body as a . The context must have first been routed to a {@link io.vertx.rxjava.ext.web.handler.BodyHandler} for this to be populated.
When the body is null or the "null" JSON literal then null is returned.
*/
public JsonObject getBodyAsJson() {
JsonObject ret = delegate.getBodyAsJson();
return ret;
}
/**
* @return Get the entire HTTP request body as a . The context must have first been routed to a {@link io.vertx.rxjava.ext.web.handler.BodyHandler} for this to be populated.
When the body is null or the "null" JSON literal then null is returned.
*/
public JsonArray getBodyAsJsonArray() {
JsonArray ret = delegate.getBodyAsJsonArray();
return ret;
}
/**
* @return Get the entire HTTP request body as a . The context must have first been routed to a {@link io.vertx.rxjava.ext.web.handler.BodyHandler} for this to be populated.
*/
public io.vertx.rxjava.core.buffer.Buffer getBody() {
io.vertx.rxjava.core.buffer.Buffer ret = io.vertx.rxjava.core.buffer.Buffer.newInstance((io.vertx.core.buffer.Buffer)delegate.getBody());
return ret;
}
/**
* @return a set of fileuploads (if any) for the request. The context must have first been routed to a {@link io.vertx.rxjava.ext.web.handler.BodyHandler} for this to work.
*/
public Set fileUploads() {
Set ret = delegate.fileUploads().stream().map(elt -> io.vertx.rxjava.ext.web.FileUpload.newInstance((io.vertx.ext.web.FileUpload)elt)).collect(java.util.stream.Collectors.toSet());
return ret;
}
/**
* Get the session. The context must have first been routed to a {@link io.vertx.rxjava.ext.web.handler.SessionHandler}
* for this to be populated.
* Sessions live for a browser session, and are maintained by session cookies.
* @return the session.
*/
public io.vertx.rxjava.ext.web.Session session() {
io.vertx.rxjava.ext.web.Session ret = io.vertx.rxjava.ext.web.Session.newInstance((io.vertx.ext.web.Session)delegate.session());
return ret;
}
/**
* Whether the {@link io.vertx.rxjava.ext.web.RoutingContext#session} has been already called or not. This is usually used by the
* {@link io.vertx.rxjava.ext.web.handler.SessionHandler}.
* @return true if the session has been accessed.
*/
public boolean isSessionAccessed() {
boolean ret = delegate.isSessionAccessed();
return ret;
}
/**
* Get the authenticated user (if any). This will usually be injected by an auth handler if authentication if successful.
* @return the user, or null if the current user is not authenticated.
*/
public io.vertx.rxjava.ext.auth.User user() {
io.vertx.rxjava.ext.auth.User ret = io.vertx.rxjava.ext.auth.User.newInstance((io.vertx.ext.auth.User)delegate.user());
return ret;
}
/**
* If the context is being routed to failure handlers after a failure has been triggered by calling
* {@link io.vertx.rxjava.ext.web.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.
* @return the throwable used when signalling failure
*/
public java.lang.Throwable failure() {
if (cached_3 != null) {
return cached_3;
}
java.lang.Throwable ret = delegate.failure();
cached_3 = ret;
return ret;
}
/**
* If the context is being routed to failure handlers after a failure has been triggered by calling
* {@link io.vertx.rxjava.ext.web.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.
* @return the status code used when signalling failure
*/
public int statusCode() {
if (cached_4 != null) {
return cached_4;
}
int ret = delegate.statusCode();
cached_4 = ret;
return ret;
}
/**
* 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.
* @return the most acceptable content type.
*/
public String getAcceptableContentType() {
String ret = delegate.getAcceptableContentType();
return ret;
}
/**
* The headers:
*
* - Accept
* - Accept-Charset
* - Accept-Encoding
* - Accept-Language
* - Content-Type
*
* Parsed into {@link io.vertx.rxjava.ext.web.ParsedHeaderValue}
* @return A container with the parsed headers.
*/
public io.vertx.rxjava.ext.web.ParsedHeaderValues parsedHeaders() {
if (cached_5 != null) {
return cached_5;
}
io.vertx.rxjava.ext.web.ParsedHeaderValues ret = io.vertx.rxjava.ext.web.ParsedHeaderValues.newInstance((io.vertx.ext.web.ParsedHeaderValues)delegate.parsedHeaders());
cached_5 = ret;
return ret;
}
/**
* 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.
* @param handler the handler
* @return the id of the handler. This can be used if you later want to remove the handler.
*/
public int addHeadersEndHandler(Handler handler) {
int ret = delegate.addHeadersEndHandler(handler);
return ret;
}
/**
* Remove a headers end handler
* @param handlerID the id as returned from {@link io.vertx.rxjava.ext.web.RoutingContext#addHeadersEndHandler}.
* @return true if the handler existed and was removed, false otherwise
*/
public boolean removeHeadersEndHandler(int handlerID) {
boolean ret = delegate.removeHeadersEndHandler(handlerID);
return ret;
}
/**
* Provides a handler that will be called after the last part of the body is written to the wire.
* The handler is called asynchronously of when the response has been received by the client.
* This provides a hook allowing you to do more operations once the request has been sent over the wire.
* Do not use this for resource cleanup as this handler might never get called (e.g. if the connection is reset).
* @param handler the handler
* @return the id of the handler. This can be used if you later want to remove the handler.
*/
public int addBodyEndHandler(Handler handler) {
int ret = delegate.addBodyEndHandler(handler);
return ret;
}
/**
* Remove a body end handler
* @param handlerID the id as returned from {@link io.vertx.rxjava.ext.web.RoutingContext#addBodyEndHandler}.
* @return true if the handler existed and was removed, false otherwise
*/
public boolean removeBodyEndHandler(int handlerID) {
boolean ret = delegate.removeBodyEndHandler(handlerID);
return ret;
}
/**
* Add an end handler for the request/response context. This will be called when the response is disposed or an
* exception has been encountered to allow consistent cleanup. The handler is called asynchronously of when the
* response has been received by the client.
* @param handler the handler that will be called with either a success or failure result.
* @return the id of the handler. This can be used if you later want to remove the handler.
*/
public int addEndHandler(Handler> handler) {
int ret = delegate.addEndHandler(handler);
return ret;
}
/**
* Remove an end handler
* @param handlerID the id as returned from {@link io.vertx.rxjava.ext.web.RoutingContext#addEndHandler}.
* @return true if the handler existed and was removed, false otherwise
*/
public boolean removeEndHandler(int handlerID) {
boolean ret = delegate.removeEndHandler(handlerID);
return ret;
}
/**
* @return true if the context is being routed to failure handlers.
*/
public boolean failed() {
boolean ret = delegate.failed();
return ret;
}
/**
* Set the body. Used by the {@link io.vertx.rxjava.ext.web.handler.BodyHandler}. You will not normally call this method.
* @param body the body
*/
public void setBody(io.vertx.rxjava.core.buffer.Buffer body) {
delegate.setBody(body.getDelegate());
}
/**
* Set the session. Used by the {@link io.vertx.rxjava.ext.web.handler.SessionHandler}. You will not normally call this method.
* @param session the session
*/
public void setSession(io.vertx.rxjava.ext.web.Session session) {
delegate.setSession(session.getDelegate());
}
/**
* Set the user. Usually used by auth handlers to inject a User. You will not normally call this method.
* @param user the user
*/
public void setUser(io.vertx.rxjava.ext.auth.User user) {
delegate.setUser(user.getDelegate());
}
/**
* 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.
*/
public void clearUser() {
delegate.clearUser();
}
/**
* Set the acceptable content type. Used by
* @param contentType the content type
*/
public void setAcceptableContentType(String contentType) {
delegate.setAcceptableContentType(contentType);
}
/**
* Restarts the current router with a new path and reusing the original method. All path parameters are then parsed
* and available on the params list. Query params will also be allowed and available.
* @param path the new http path.
*/
public void reroute(String path) {
delegate.reroute(path);
}
/**
* Restarts the current router with a new method and path. All path parameters are then parsed and available on the
* params list. Query params will also be allowed and available.
* @param method the new http request
* @param path the new http path.
*/
public void reroute(io.vertx.core.http.HttpMethod method, String path) {
delegate.reroute(method, path);
}
/**
* 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.
* @return the best matched locale for the request
*/
@Deprecated()
public List acceptableLocales() {
if (cached_6 != null) {
return cached_6;
}
List ret = delegate.acceptableLocales().stream().map(elt -> io.vertx.rxjava.ext.web.Locale.newInstance((io.vertx.ext.web.Locale)elt)).collect(java.util.stream.Collectors.toList());
cached_6 = ret;
return ret;
}
/**
* Returns the languages for the current request. The languages are determined from the 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.
* @return The best matched language for the request
*/
public List acceptableLanguages() {
if (cached_7 != null) {
return cached_7;
}
List ret = delegate.acceptableLanguages().stream().map(elt -> io.vertx.rxjava.ext.web.LanguageHeader.newInstance((io.vertx.ext.web.LanguageHeader)elt)).collect(java.util.stream.Collectors.toList());
cached_7 = ret;
return ret;
}
/**
* Helper to return the user preferred locale. It is the same action as returning the first element of the acceptable
* locales.
* @return the users preferred locale.
*/
@Deprecated()
public io.vertx.rxjava.ext.web.Locale preferredLocale() {
if (cached_8 != null) {
return cached_8;
}
io.vertx.rxjava.ext.web.Locale ret = io.vertx.rxjava.ext.web.Locale.newInstance((io.vertx.ext.web.Locale)delegate.preferredLocale());
cached_8 = ret;
return ret;
}
/**
* Helper to return the user preferred language.
* It is the same action as returning the first element of the acceptable languages.
* @return the users preferred locale.
*/
public io.vertx.rxjava.ext.web.LanguageHeader preferredLanguage() {
if (cached_9 != null) {
return cached_9;
}
io.vertx.rxjava.ext.web.LanguageHeader ret = io.vertx.rxjava.ext.web.LanguageHeader.newInstance((io.vertx.ext.web.LanguageHeader)delegate.preferredLanguage());
cached_9 = ret;
return ret;
}
/**
* Returns a map of named parameters as defined in path declaration with their actual values
* @return the map of named parameters
*/
public java.util.Map pathParams() {
java.util.Map ret = delegate.pathParams();
return ret;
}
/**
* Gets the value of a single path parameter
* @param name the name of parameter as defined in path declaration
* @return the actual value of the parameter or null if it doesn't exist
*/
public String pathParam(String name) {
String ret = delegate.pathParam(name);
return ret;
}
/**
* 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. If the query string is invalid
* it fails the context
* @return the multimap of query parameters
*/
public io.vertx.rxjava.core.MultiMap queryParams() {
io.vertx.rxjava.core.MultiMap ret = io.vertx.rxjava.core.MultiMap.newInstance((io.vertx.core.MultiMap)delegate.queryParams());
return ret;
}
/**
* Gets the value of a single query parameter. For more info {@link io.vertx.rxjava.ext.web.RoutingContext#queryParams}
* @param name The name of query parameter
* @return The list of all parameters matching the parameter name. It returns an empty list if no query parameter with name was found
*/
public List queryParam(String name) {
List ret = delegate.queryParam(name);
return ret;
}
/**
* @return all the context data as a map
*/
public java.util.Map data() {
java.util.Map ret = delegate.data();
return ret;
}
private io.vertx.rxjava.core.http.HttpServerRequest cached_0;
private io.vertx.rxjava.core.http.HttpServerResponse cached_1;
private io.vertx.rxjava.core.Vertx cached_2;
private java.lang.Throwable cached_3;
private java.lang.Integer cached_4;
private io.vertx.rxjava.ext.web.ParsedHeaderValues cached_5;
private List cached_6;
private List cached_7;
private io.vertx.rxjava.ext.web.Locale cached_8;
private io.vertx.rxjava.ext.web.LanguageHeader cached_9;
public static RoutingContext newInstance(io.vertx.ext.web.RoutingContext arg) {
return arg != null ? new RoutingContext(arg) : null;
}
}