{@code
* {
* path("/api/pets", () -> {
*
* });
* }
* }
*
* @param path Common path.
* @param action Router action.
* @return This router.
*/
Route.Collection path(String path, Runnable action);
/**
* Import content from provide application (routes, parsers/renderers, start/stop callbacks, ...
* etc.). Routes will be mounted at the provided path.
*
* @param path Path to mount the given app.
* @param app Routes provider.
* @return This router.
*/
@Nonnull
Router use(final String path, final Jooby app);
/**
* Append a new filter that matches any method under the given path.
*
* @param path A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition use(String path, Route.Filter filter);
/**
* Append a new filter that matches the given method and path.
*
* @param method A HTTP method.
* @param path A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition use(String method, String path, Route.Filter filter);
/**
* Append a new route handler that matches the given method and path. Like
* {@link #use(String, String, org.jooby.Route.Filter)} but you don't have to explicitly call
* {@link Route.Chain#next(Request, Response)}.
*
* @param method A HTTP method.
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition use(String method, String path, Route.Handler handler);
/**
* Append a new route handler that matches any method under the given path. Like
* {@link #use(String, org.jooby.Route.Filter)} but you don't have to explicitly call
* {@link Route.Chain#next(Request, Response)}.
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition use(String path, Route.Handler handler);
/**
* Append a new route handler that matches any method under the given path.
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition use(String path, Route.OneArgHandler handler);
/**
* Append a route that matches the HTTP GET method:
*
*
* get((req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition get(Route.Handler handler) {
return get("/", handler);
}
/**
* Append a route that matches the HTTP GET method:
*
*
* get("/", (req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition get(String path, Route.Handler handler);
/**
* Append two routes that matches the HTTP GET method on the same handler:
*
*
* get("/model", "/mode/:id", (req, rsp) {@literal ->} {
* rsp.send(req.param("id").toOptional(String.class));
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection get(String path1, String path2, Route.Handler handler);
/**
* Append three routes that matches the HTTP GET method on the same handler:
*
*
* get("/p1", "/p2", "/p3", (req, rsp) {@literal ->} {
* rsp.send(req.path());
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection get(String path1, String path2, String path3, Route.Handler handler);
/**
* Append route that matches the HTTP GET method:
*
*
* get(req {@literal ->} {
* return "hello";
* });
*
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition get(Route.OneArgHandler handler) {
return get("/", handler);
}
/**
* Append route that matches the HTTP GET method:
*
*
* get("/", req {@literal ->} {
* return "hello";
* });
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition get(String path, Route.OneArgHandler handler);
/**
* Append three routes that matches the HTTP GET method on the same handler:
*
*
* get("/model", "/model/:id", req {@literal ->} {
* return req.param("id").toOptional(String.class);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection get(String path1, String path2, Route.OneArgHandler handler);
/**
* Append three routes that matches the HTTP GET method on the same handler:
*
*
* get("/p1", "/p2", "/p3", req {@literal ->} {
* return req.path();
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection get(String path1, String path2, String path3, Route.OneArgHandler handler);
/**
* Append route that matches HTTP GET method:
*
*
* get(() {@literal ->}
* "hello"
* );
*
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition get(Route.ZeroArgHandler handler) {
return get("/", handler);
}
/**
* Append route that matches HTTP GET method:
*
*
* get("/", () {@literal ->}
* "hello"
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition get(String path, Route.ZeroArgHandler handler);
/**
* Append three routes that matches the HTTP GET method on the same handler:
*
*
* get("/p1", "/p2", () {@literal ->} {
* return "OK";
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection get(String path1, String path2, Route.ZeroArgHandler handler);
/**
* Append three routes that matches HTTP GET method on the same handler:
*
*
* get("/p1", "/p2", "/p3", () {@literal ->} {
* return "OK";
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection get(String path1, String path2, String path3, Route.ZeroArgHandler handler);
/**
* Append a filter that matches HTTP GET method:
*
*
* get("/", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition get(String path, Route.Filter filter);
/**
* Append three routes that matches the HTTP GET method on the same handler:
*
*
* get("/model", "/model/:id", (req, rsp, chain) {@literal ->} {
* req.param("id").toOptional(String.class);
* chain.next(req, rsp);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection get(String path1, String path2, Route.Filter filter);
/**
* Append three routes that supports HTTP GET method on the same handler:
*
*
* get("/p1", "/p2", "/p3", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection get(String path1, String path2, String path3, Route.Filter filter);
/**
* Append a route that supports HTTP POST method:
*
*
* post((req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition post(Route.Handler handler) {
return post("/", handler);
}
/**
* Append a route that supports HTTP POST method:
*
*
* post("/", (req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition post(String path, Route.Handler handler);
/**
* Append three routes that supports HTTP POST method on the same handler:
*
*
* post("/p1", "/p2", (req, rsp) {@literal ->} {
* rsp.send(req.path());
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection post(String path1, String path2, Route.Handler handler);
/**
* Append three routes that supports HTTP POST method on the same handler:
*
*
* post("/p1", "/p2", "/p3", (req, rsp) {@literal ->} {
* rsp.send(req.path());
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection post(String path1, String path2, String path3, Route.Handler handler);
/**
* Append route that supports HTTP POST method:
*
*
* post(req {@literal ->}
* "hello"
* );
*
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition post(Route.OneArgHandler handler) {
return post("/", handler);
}
/**
* Append route that supports HTTP POST method:
*
*
* post("/", req {@literal ->}
* "hello"
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition post(String path, Route.OneArgHandler handler);
/**
* Append three routes that supports HTTP POST method on the same handler:
*
*
* post("/p1", "/p2", req {@literal ->} {
* return req.path();
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection post(String path1, String path2, Route.OneArgHandler handler);
/**
* Append three routes that supports HTTP POST method on the same handler:
*
*
* post("/p1", "/p2", "/p3", req {@literal ->} {
* return req.path();
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection post(String path1, String path2, String path3, Route.OneArgHandler handler);
/**
* Append route that supports HTTP POST method:
*
*
* post(() {@literal ->}
* "hello"
* );
*
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition post(Route.ZeroArgHandler handler) {
return post("/", handler);
}
/**
* Append route that supports HTTP POST method:
*
*
* post("/", () {@literal ->}
* "hello"
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition post(String path, Route.ZeroArgHandler handler);
/**
* Append three routes that supports HTTP POST method on the same handler:
*
*
* post("/p1", "/p2", {@literal ->} {
* return "OK";
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection post(String path1, String path2, Route.ZeroArgHandler handler);
/**
* Append three routes that supports HTTP POST method on the same handler:
*
*
* post("/p1", "/p2", "/p3", () {@literal ->} {
* return "OK";
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection post(String path1, String path2, String path3, Route.ZeroArgHandler handler);
/**
* Append a route that supports HTTP POST method:
*
*
* post("/", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition post(String path, Route.Filter filter);
/**
* Append three routes that supports HTTP POST method on the same handler:
*
*
* post("/p1", "/p2",(req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection post(String path1, String path2, Route.Filter filter);
/**
* Append three routes that supports HTTP POST method on the same handler:
*
*
* post("/p1", "/p2", "/p3", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection post(String path1, String path2, String path3, Route.Filter filter);
/**
* Append a route that supports HTTP HEAD method:
*
*
* post("/", (req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition head(String path, Route.Handler handler);
/**
* Append route that supports HTTP HEAD method:
*
*
* head("/", req {@literal ->}
* "hello"
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition head(String path, Route.OneArgHandler handler);
/**
* Append route that supports HTTP HEAD method:
*
*
* head("/", () {@literal ->}
* "hello"
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition head(String path, Route.ZeroArgHandler handler);
/**
* Append a route that supports HTTP HEAD method:
*
*
* post("/", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition head(String path, Route.Filter filter);
/**
* Append a new route that automatically handles HEAD request from existing GET routes.
*
*
* {
* head();
* }
*
*
* @return A new route definition.
*/
@Nonnull
Route.Definition head();
/**
* Append a route that supports HTTP OPTIONS method:
*
*
* options("/", (req, rsp) {@literal ->} {
* rsp.header("Allow", "GET, POST");
* });
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition options(String path, Route.Handler handler);
/**
* Append route that supports HTTP OPTIONS method:
*
*
* options("/", req {@literal ->}
* return Results.with(200).header("Allow", "GET, POST")
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition options(String path, Route.OneArgHandler handler);
/**
* Append route that supports HTTP OPTIONS method:
*
*
* options("/", () {@literal ->}
* return Results.with(200).header("Allow", "GET, POST")
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition options(String path, Route.ZeroArgHandler handler);
/**
* Append a route that supports HTTP OPTIONS method:
*
*
* options("/", (req, rsp, chain) {@literal ->} {
* rsp.header("Allow", "GET, POST");
* chain.next(req, rsp);
* });
*
*
* @param path A path pattern.
* @param filter A callback to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition options(String path, Route.Filter filter);
/**
* Append a new route that automatically handles OPTIONS requests.
*
*
* get("/", (req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
* post("/", (req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
* options("/");
*
*
* OPTIONS / produces a response with a Allow header set to: GET, POST.
*
* @return A new route definition.
*/
@Nonnull
Route.Definition options();
/**
* Append route that supports HTTP PUT method:
*
*
* put((req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param handler A route to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition put(Route.Handler handler) {
return put("/", handler);
}
/**
* Append route that supports HTTP PUT method:
*
*
* put("/", (req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param path A path pattern.
* @param handler A route to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition put(String path, Route.Handler handler);
/**
* Append three routes that supports HTTP PUT method on the same handler:
*
*
* put("/p1", "/p2", (req, rsp) {@literal ->} {
* rsp.send(req.path());
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection put(String path1, String path2, Route.Handler handler);
/**
* Append three routes that supports HTTP PUT method on the same handler:
*
*
* put("/p1", "/p2", "/p3", (req, rsp) {@literal ->} {
* rsp.send(req.path());
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection put(String path1, String path2, String path3, Route.Handler handler);
/**
* Append route that supports HTTP PUT method:
*
*
* put(req {@literal ->}
* return Results.accepted();
* );
*
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition put(Route.OneArgHandler handler) {
return put("/", handler);
}
/**
* Append route that supports HTTP PUT method:
*
*
* put("/", req {@literal ->}
* return Results.accepted();
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition put(String path, Route.OneArgHandler handler);
/**
* Append three routes that supports HTTP PUT method on the same handler:
*
*
* put("/p1", "/p2", req {@literal ->} {
* return req.path();
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection put(String path1, String path2, Route.OneArgHandler handler);
/**
* Append three routes that supports HTTP PUT method on the same handler:
*
*
* put("/p1", "/p2", "/p3", req {@literal ->} {
* return req.path();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection put(String path1, String path2, String path3, Route.OneArgHandler handler);
/**
* Append route that supports HTTP PUT method:
*
*
* put(() {@literal ->} {
* return Results.accepted()
* });
*
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition put(Route.ZeroArgHandler handler) {
return put("/", handler);
}
/**
* Append route that supports HTTP PUT method:
*
*
* put("/", () {@literal ->} {
* return Results.accepted()
* });
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition put(String path, Route.ZeroArgHandler handler);
/**
* Append three routes that supports HTTP PUT method on the same handler:
*
*
* put("/p1", "/p2", req {@literal ->} {
* return req.path();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection put(String path1, String path2, Route.ZeroArgHandler handler);
/**
* Append three routes that supports HTTP PUT method on the same handler:
*
*
* put("/p1", "/p2", "/p3", req {@literal ->} {
* return req.path();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection put(String path1, String path2, String path3, Route.ZeroArgHandler handler);
/**
* Append route that supports HTTP PUT method:
*
*
* put("/", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path A path pattern.
* @param filter A callback to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition put(String path, Route.Filter filter);
/**
* Append three routes that supports HTTP PUT method on the same handler:
*
*
* put("/p1", "/p2", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection put(String path1, String path2, Route.Filter filter);
/**
* Append three routes that supports HTTP PUT method on the same handler:
*
*
* put("/p1", "/p2", "/p3", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection put(String path1, String path2, String path3, Route.Filter filter);
/**
* Append route that supports HTTP PATCH method:
*
*
* patch((req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param handler A route to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition patch(Route.Handler handler) {
return patch("/", handler);
}
/**
* Append route that supports HTTP PATCH method:
*
*
* patch("/", (req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param path A path pattern.
* @param handler A route to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition patch(String path, Route.Handler handler);
/**
* Append three routes that supports HTTP PATCH method on the same handler:
*
*
* patch("/p1", "/p2", (req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection patch(String path1, String path2, Route.Handler handler);
/**
* Append three routes that supports HTTP PATCH method on the same handler:
*
*
* patch("/p1", "/p2", "/p3", (req, rsp) {@literal ->} {
* rsp.send(something);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
Route.Collection patch(String path1, String path2, String path3, Route.Handler handler);
/**
* Append route that supports HTTP PATCH method:
*
*
* patch(req {@literal ->}
* Results.ok()
* );
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition patch(Route.OneArgHandler handler) {
return patch("/", handler);
}
/**
* Append route that supports HTTP PATCH method:
*
*
* patch("/", req {@literal ->}
* Results.ok()
* );
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition patch(String path, Route.OneArgHandler handler);
/**
* Append three routes that supports HTTP PATCH method on the same handler:
*
*
* patch("/p1", "/p2", req {@literal ->} {
* return req.path();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection patch(String path1, String path2, Route.OneArgHandler handler);
/**
* Append three routes that supports HTTP PATCH method on the same handler:
*
*
* patch("/p1", "/p2", "/p3", req {@literal ->} {
* return req.path();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection patch(String path1, String path2, String path3, Route.OneArgHandler handler);
/**
* Append route that supports HTTP PATCH method:
*
*
* patch(() {@literal ->} {
* return Results.ok();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition patch(Route.ZeroArgHandler handler) {
return patch("/", handler);
}
/**
* Append route that supports HTTP PATCH method:
*
*
* patch("/", () {@literal ->} {
* return Results.ok();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition patch(String path, Route.ZeroArgHandler handler);
/**
* Append three routes that supports HTTP PATCH method on the same handler:
*
*
* patch("/p1", "/p2", () {@literal ->} {
* return Results.ok();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection patch(String path1, String path2, Route.ZeroArgHandler handler);
/**
* Append three routes that supports HTTP PATCH method on the same handler:
*
*
* patch("/p1", "/p2", "/p3", () {@literal ->} {
* return Results.ok();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection patch(String path1, String path2, String path3, Route.ZeroArgHandler handler);
/**
* Append route that supports HTTP PATCH method:
*
*
* patch("/", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path A path pattern.
* @param filter A callback to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition patch(String path, Route.Filter filter);
/**
* Append three routes that supports HTTP PATCH method on the same handler:
*
*
* patch("/p1", "/p2", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection patch(String path1, String path2, Route.Filter filter);
/**
* Append three routes that supports HTTP PATCH method on the same handler:
*
*
* patch("/p1", "/p2", "/p3", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection patch(String path1, String path2, String path3, Route.Filter filter);
/**
* Append a route that supports HTTP DELETE method:
*
*
* delete((req, rsp) {@literal ->} {
* rsp.status(204);
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition delete(Route.Handler handler) {
return delete("/", handler);
}
/**
* Append a route that supports HTTP DELETE method:
*
*
* delete("/", (req, rsp) {@literal ->} {
* rsp.status(204);
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition delete(String path, Route.Handler handler);
/**
* Append three routes that supports HTTP DELETE method on the same handler:
*
*
* delete("/p1", "/p2", (req, rsp) {@literal ->} {
* rsp.status(204);
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection delete(String path1, String path2, Route.Handler handler);
/**
* Append three routes that supports HTTP DELETE method on the same handler:
*
*
* delete("/p1", "/p2", "/p3", (req, rsp) {@literal ->} {
* rsp.status(204);
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection delete(String path1, String path2, String path3, Route.Handler handler);
/**
* Append route that supports HTTP DELETE method:
*
*
* delete(req {@literal ->}
* return Results.noContent();
* );
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition delete(Route.OneArgHandler handler) {
return delete("/", handler);
}
/**
* Append route that supports HTTP DELETE method:
*
*
* delete("/", req {@literal ->}
* return Results.noContent();
* );
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition delete(String path, Route.OneArgHandler handler);
/**
* Append three routes that supports HTTP DELETE method on the same handler:
*
*
* delete("/p1", "/p2", req {@literal ->} {
* return Results.noContent();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection delete(String path1, String path2, Route.OneArgHandler handler);
/**
* Append three routes that supports HTTP DELETE method on the same handler:
*
*
* delete("/p1", "/p2", "/p3",req {@literal ->} {
* return Results.noContent();
* });
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection delete(String path1, String path2, String path3, Route.OneArgHandler handler);
/**
* Append route that supports HTTP DELETE method:
*
*
* delete(() {@literal ->}
* return Results.noContent();
* );
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
default Route.Definition delete(Route.ZeroArgHandler handler) {
return delete("/", handler);
}
/**
* Append route that supports HTTP DELETE method:
*
*
* delete("/", () {@literal ->}
* return Results.noContent();
* );
*
*
* This is a singleton route so make sure you don't share or use global variables.
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition delete(String path, Route.ZeroArgHandler handler);
/**
* Append three routes that supports HTTP DELETE method on the same handler:
*
*
* delete("/p1", "/p2", () {@literal ->} {
* return Results.noContent();
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection delete(String path1, String path2, Route.ZeroArgHandler handler);
/**
* Append three routes that supports HTTP DELETE method on the same handler:
*
*
* delete("/p1", "/p2", "/p3", req {@literal ->} {
* return Results.noContent();
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection delete(String path1, String path2, String path3, Route.ZeroArgHandler handler);
/**
* Append a route that supports HTTP DELETE method:
*
*
* delete("/", (req, rsp, chain) {@literal ->} {
* rsp.status(304);
* chain.next(req, rsp);
* });
*
*
* @param path A path pattern.
* @param filter A callback to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition delete(String path, Route.Filter filter);
/**
* Append three routes that supports HTTP DELETE method on the same handler:
*
*
* delete("/p1", "/p2", (req, rsp, chain) {@literal ->} {
* rsp.status(304);
* chain.next(req, rsp);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection delete(String path1, String path2, Route.Filter filter);
/**
* Append three routes that supports HTTP DELETE method on the same handler:
*
*
* delete("/p1", "/p2", "/p3", (req, rsp, chain) {@literal ->} {
* rsp.status(304);
* chain.next(req, rsp);
* });
*
*
* @param path1 A path pattern.
* @param path2 A path pattern.
* @param path3 A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Collection delete(String path1, String path2, String path3, Route.Filter filter);
/**
* Append a route that supports HTTP TRACE method:
*
*
* trace("/", (req, rsp) {@literal ->} {
* rsp.send(...);
* });
*
*
* @param path A path pattern.
* @param handler A callback to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition trace(String path, Route.Handler handler);
/**
* Append route that supports HTTP TRACE method:
*
*
* trace("/", req {@literal ->}
* "trace"
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition trace(String path, Route.OneArgHandler handler);
/**
* Append route that supports HTTP TRACE method:
*
*
* trace("/", () {@literal ->}
* "trace"
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition trace(String path, Route.ZeroArgHandler handler);
/**
* Append a route that supports HTTP TRACE method:
*
*
* trace("/", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path A path pattern.
* @param filter A callback to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition trace(String path, Route.Filter filter);
/**
* Append a default trace implementation under the given path. Default trace response, looks
* like:
*
* * TRACE /path * header1: value * header2: value ** * @return A new route definition. */ @Nonnull Route.Definition trace(); /** * Append a route that supports HTTP CONNECT method: * *
* connect("/", (req, rsp) {@literal ->} {
* });
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition connect(String path, Route.Handler handler);
/**
* Append route that supports HTTP CONNECT method:
*
*
* connect("/", req {@literal ->}
* "hello"
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition connect(String path, Route.OneArgHandler handler);
/**
* Append route that supports HTTP CONNECT method:
*
*
* connect("/", () {@literal ->}
* "connected"
* );
*
*
* @param path A path pattern.
* @param handler A handler to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition connect(String path, Route.ZeroArgHandler handler);
/**
* Append a route that supports HTTP CONNECT method:
*
*
* connect("/", (req, rsp, chain) {@literal ->} {
* chain.next(req, rsp);
* });
*
*
* @param path A path pattern.
* @param filter A filter to execute.
* @return A new route definition.
*/
@Nonnull
Route.Definition connect(String path, Route.Filter filter);
/**
* Static files handler.
*
*
* assets("/assets/**");
*
*
* Resources are served from root of classpath, for example GET /assets/file.js will
* be resolve as classpath resource at the same location.
*
* The {@link AssetHandler} one step forward and add support for serving files from a CDN out of
* the box. All you have to do is to define a assets.cdn property:
*
* * assets.cdn = "http://d7471vfo50fqt.cloudfront.net" ** * A GET to
/assets/js/index.js will be redirected to:
* http://d7471vfo50fqt.cloudfront.net/assets/js/index.js.
*
* You can turn on/off ETag and Last-Modified headers too using
* assets.etag and assets.lastModified. These two properties are enabled
* by default.
*
* @param path The path to publish.
* @return A new route definition.
*/
@Nonnull
default Route.AssetDefinition assets(final String path) {
return assets(path, "/");
}
/**
* Static files handler on external location.
*
*
* assets("/assets/**", Paths.get("/www"));
*
*
* For example GET /assets/file.js will be resolve as /www/file.js on
* server file system.
*
*
* The {@link AssetHandler} one step forward and add support for serving files from a CDN out of
* the box. All you have to do is to define a assets.cdn property:
*
* assets.cdn = "http://d7471vfo50fqt.cloudfront.net" ** * A GET to
/assets/js/index.js will be redirected to:
* http://d7471vfo50fqt.cloudfront.net/assets/js/index.js.
*
* You can turn on/off ETag and Last-Modified headers too using
* assets.etag and assets.lastModified. These two properties are enabled
* by default.
*
* @param path The path to publish.
* @param basedir Base directory.
* @return A new route definition.
*/
@Nonnull
Route.AssetDefinition assets(final String path, Path basedir);
/**
* Static files handler. Like {@link #assets(String)} but let you specify a different classpath
* location.
*
* * Basic example *
* *
* assets("/js/**", "/");
*
*
* A request for: /js/jquery.js will be translated to: /lib/jquery.js.
*
* * Webjars example: *
* *
* assets("/js/**", "/resources/webjars/{0}");
*
*
* A request for: /js/jquery/2.1.3/jquery.js will be translated to:
* /resources/webjars/jquery/2.1.3/jquery.js.
* The {0} represent the ** capturing group.
*
* * Another webjars example: *
* *
* assets("/js/*-*.js", "/resources/webjars/{0}/{1}/{0}.js");
*
*
*
* A request for: /js/jquery-2.1.3.js will be translated to:
* /resources/webjars/jquery/2.1.3/jquery.js.
*
* Append MVC routes from a controller like class: *
* ** use(MyRoute.class); ** * Where MyRoute.java is: * *
* {@literal @}Path("/")
* public class MyRoute {
*
* {@literal @}GET
* public String hello() {
* return "Hello Jooby";
* }
* }
*
* * Programming model is quite similar to JAX-RS/Jersey with some minor differences and/or * simplifications. *
* ** To learn more about Mvc Routes, please check {@link org.jooby.mvc.Path}, * {@link org.jooby.mvc.Produces} {@link org.jooby.mvc.Consumes}. *
* * @param routeClass A route(s) class. * @return This router. */ @Nonnull Route.Collection use(Class routeClass); /** ** Append MVC routes from a controller like class: *
* *
* use("/pets", MyRoute.class);
*
*
* Where MyRoute.java is:
*
*
* {@literal @}Path("/")
* public class MyRoute {
*
* {@literal @}GET
* public String hello() {
* return "Hello Jooby";
* }
* }
*
* * Programming model is quite similar to JAX-RS/Jersey with some minor differences and/or * simplifications. *
* ** To learn more about Mvc Routes, please check {@link org.jooby.mvc.Path}, * {@link org.jooby.mvc.Produces} {@link org.jooby.mvc.Consumes}. *
* * @param path Path to mount the route. * @param routeClass A route(s) class. * @return This router. */ @Nonnull Route.Collection use(String path, Class routeClass); /** *{@code
* {
* before((req, rsp) -> {
* // your code goes here
* });
* }
* }
*
* You are allowed to modify the request and response objects.
*
* Please note that the before handler is just syntax sugar for {@link Route.Filter}.
* For example, the before handler was implemented as:
*
* {@code
* {
* use("*", "*", (req, rsp, chain) -> {
* before(req, rsp);
* // your code goes here
* chain.next(req, rsp);
* });
* }
* }
*
* A before handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* before((req, rsp) -> {
* // your code goes here
* });
*
* get("/path", req -> {
* // your code goes here
* return ...;
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param handler Before handler. * @return A new route definition. */ @Nonnull default Route.Definition before(final Route.Before handler) { return before("*", handler); } /** *{@code
* {
* before((req, rsp) -> {
* // your code goes here
* });
* }
* }
*
* You are allowed to modify the request and response objects.
*
* Please note that the before handler is just syntax sugar for {@link Route.Filter}.
* For example, the before handler was implemented as:
*
* {@code
* {
* use("*", "*", (req, rsp, chain) -> {
* before(req, rsp);
* // your code goes here
* chain.next(req, rsp);
* });
* }
* }
*
* A before handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* before((req, rsp) -> {
* // your code goes here
* });
*
* get("/path", req -> {
* // your code goes here
* return ...;
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param handler Before handler. * @param next Next handler. * @return A new route definition. */ @Nonnull default Route.Collection before(final Route.Before handler, Route.Before... next) { return before("*", handler, next); } /** *{@code
* {
* before("*", (req, rsp) -> {
* // your code goes here
* });
* }
* }
*
* You are allowed to modify the request and response objects.
*
* Please note that the before handler is just syntax sugar for {@link Route.Filter}.
* For example, the before handler was implemented as:
*
* {@code
* {
* use("*", (req, rsp, chain) -> {
* before(req, rsp);
* chain.next(req, rsp);
* });
* }
* }
*
* A before handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* before("/path", (req, rsp) -> {
* // your code goes here
* });
*
* get("/path", req -> {
* // your code goes here
* return ...;
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param pattern Pattern to intercept. * @param handler Before handler. * @return A new route definition. */ @Nonnull default Route.Definition before(final String pattern, final Route.Before handler) { return before("*", pattern, handler); } /** *{@code
* {
* before("*", (req, rsp) -> {
* // your code goes here
* });
* }
* }
*
* You are allowed to modify the request and response objects.
*
* Please note that the before handler is just syntax sugar for {@link Route.Filter}.
* For example, the before handler was implemented as:
*
* {@code
* {
* use("*", (req, rsp, chain) -> {
* before(req, rsp);
* chain.next(req, rsp);
* });
* }
* }
*
* A before handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* before("/path", (req, rsp) -> {
* // your code goes here
* });
*
* get("/path", req -> {
* // your code goes here
* return ...;
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param pattern Pattern to intercept. * @param handler Before handler. * @param next Next handler. * @return A new route definition. */ @Nonnull default Route.Collection before(String pattern, Route.Before handler, Route.Before... next) { return before("*", pattern, handler, next); } /** *{@code
* {
* before("GET", "*", (req, rsp) -> {
* // your code goes here
* });
* }
* }
*
* You are allowed to modify the request and response objects.
*
* Please note that the before handler is just syntax sugar for {@link Route.Filter}.
* For example, the before handler was implemented as:
*
* {@code
* {
* use("GET", "*", (req, rsp, chain) -> {
* before(req, rsp);
* chain.next(req, rsp);
* });
* }
* }
*
* A before handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* before("GET", "/path", (req, rsp) -> {
* // your code goes here
* });
*
* get("/path", req -> {
* // your code goes here
* return ...;
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param method HTTP method to intercept. * @param pattern Pattern to intercept. * @param handler Before handler. * @return A new route definition. */ @Nonnull Route.Definition before(String method, String pattern, Route.Before handler); /** *{@code
* {
* before("GET", "*", (req, rsp) -> {
* // your code goes here
* });
* }
* }
*
* You are allowed to modify the request and response objects.
*
* Please note that the before handler is just syntax sugar for {@link Route.Filter}.
* For example, the before handler was implemented as:
*
* {@code
* {
* use("GET", "*", (req, rsp, chain) -> {
* before(req, rsp);
* chain.next(req, rsp);
* });
* }
* }
*
* A before handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* before("GET", "/path", (req, rsp) -> {
* // your code goes here
* });
*
* get("/path", req -> {
* // your code goes here
* return ...;
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param method HTTP method to intercept. * @param pattern Pattern to intercept. * @param handler Before handler. * @param next Next handler. * @return A new route definition. */ @Nonnull default Route.Collection before(String method, String pattern, Route.Before handler, Route.Before... next) { List{@code
* {
* after((req, rsp, result) -> {
* // your code goes here
* return result;
* });
* }
* }
*
* You are allowed to modify the request, response and result objects. The handler returns a
* {@link Result} which can be the same or an entirely new {@link Result}.
*
* A after handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* after((req, rsp, result) -> {
* // your code goes here
* return result;
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param handler After handler. * @return A new route definition. */ @Nonnull default Route.Definition after(Route.After handler) { return after("*", handler); } /** *{@code
* {
* after((req, rsp, result) -> {
* // your code goes here
* return result;
* });
* }
* }
*
* You are allowed to modify the request, response and result objects. The handler returns a
* {@link Result} which can be the same or an entirely new {@link Result}.
*
* A after handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* after((req, rsp, result) -> {
* // your code goes here
* return result;
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param handler After handler. * @param next Next handler. * @return A new route definition. */ @Nonnull default Route.Collection after(Route.After handler, Route.After... next) { return after("*", handler, next); } /** *{@code
* {
* after("*", (req, rsp, result) -> {
* // your code goes here
* return result;
* });
* }
* }
*
* You are allowed to modify the request, response and result objects. The handler returns a
* {@link Result} which can be the same or an entirely new {@link Result}.
*
* A after handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* after("/path", (req, rsp, result) -> {
* // your code goes here
* return result;
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param pattern Pattern to intercept. * @param handler After handler. * @return A new route definition. */ @Nonnull default Route.Definition after(final String pattern, final Route.After handler) { return after("*", pattern, handler); } /** *{@code
* {
* after("*", (req, rsp, result) -> {
* // your code goes here
* return result;
* });
* }
* }
*
* You are allowed to modify the request, response and result objects. The handler returns a
* {@link Result} which can be the same or an entirely new {@link Result}.
*
* A after handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* after("/path", (req, rsp, result) -> {
* // your code goes here
* return result;
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param pattern Pattern to intercept. * @param handler After handler. * @param next Next handler. * @return A new route definition. */ @Nonnull default Route.Collection after(String pattern, Route.After handler, Route.After... next) { return after("*", pattern, handler, next); } /** *{@code
* {
* after("GET", "*", (req, rsp, result) -> {
* // your code goes here
* return result;
* });
* }
* }
*
* You are allowed to modify the request, response and result objects. The handler returns a
* {@link Result} which can be the same or an entirely new {@link Result}.
*
* A after handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* after("GET", "/path", (req, rsp, result) -> {
* // your code goes here
* return result;
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param method HTTP method to intercept. * @param pattern Pattern to intercept. * @param handler After handler. * @return A new route definition. */ @Nonnull Route.Definition after(String method, String pattern, Route.After handler); /** *{@code
* {
* after("GET", "*", (req, rsp, result) -> {
* // your code goes here
* return result;
* });
* }
* }
*
* You are allowed to modify the request, response and result objects. The handler returns a
* {@link Result} which can be the same or an entirely new {@link Result}.
*
* A after handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* after("GET", "/path", (req, rsp, result) -> {
* // your code goes here
* return result;
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* * @param method HTTP method to intercept. * @param pattern Pattern to intercept. * @param handler After handler. * @param next Next handler. * @return A new route definition. */ @Nonnull default Route.Collection after(String method, String pattern, Route.After handler, Route.After... next) { List{@code
* {
* complete((req, rsp, cause) -> {
* // your code goes here
* });
* }
* }
*
* You are NOT allowed to modify the request and response objects. The cause is an
* {@link Optional} with a {@link Throwable} useful to identify problems.
*
* The goal of the after handler is to probably cleanup request object and log
* responses.
*
* A complete handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* complete((req, rsp, cause) -> {
* // your code goes here
* });
*
* get(req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* *
* Suppose you have a transactional resource, like a database connection. The next example shows
* you how to implement a simple and effective transaction-per-request pattern:
*
{@code
* {
* // start transaction
* before((req, rsp) -> {
* DataSource ds = req.require(DataSource.class);
* Connection connection = ds.getConnection();
* Transaction trx = connection.getTransaction();
* trx.begin();
* req.set("connection", connection);
* return true;
* });
*
* // commit/rollback transaction
* complete((req, rsp, cause) -> {
* // unbind connection from request
* try(Connection connection = req.unset("connection").get()) {
* Transaction trx = connection.getTransaction();
* if (cause.ifPresent()) {
* trx.rollback();
* } else {
* trx.commit();
* }
* }
* });
*
* // your transactional routes goes here
* get("/api/something", req -> {
* Connection connection = req.get("connection");
* // work with connection
* });
* }
* }
*
* @param handler Complete handler.
* @return A new route definition.
*/
@Nonnull
default Route.Definition complete(final Route.Complete handler) {
return complete("*", handler);
}
/**
* {@code
* {
* complete((req, rsp, cause) -> {
* // your code goes here
* });
* }
* }
*
* You are NOT allowed to modify the request and response objects. The cause is an
* {@link Optional} with a {@link Throwable} useful to identify problems.
*
* The goal of the after handler is to probably cleanup request object and log
* responses.
*
* A complete handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* complete((req, rsp, cause) -> {
* // your code goes here
* });
*
* get(req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* *
* Suppose you have a transactional resource, like a database connection. The next example shows
* you how to implement a simple and effective transaction-per-request pattern:
*
{@code
* {
* // start transaction
* before((req, rsp) -> {
* DataSource ds = req.require(DataSource.class);
* Connection connection = ds.getConnection();
* Transaction trx = connection.getTransaction();
* trx.begin();
* req.set("connection", connection);
* return true;
* });
*
* // commit/rollback transaction
* complete((req, rsp, cause) -> {
* // unbind connection from request
* try(Connection connection = req.unset("connection").get()) {
* Transaction trx = connection.getTransaction();
* if (cause.ifPresent()) {
* trx.rollback();
* } else {
* trx.commit();
* }
* }
* });
*
* // your transactional routes goes here
* get("/api/something", req -> {
* Connection connection = req.get("connection");
* // work with connection
* });
* }
* }
*
* @param handler Complete handler.
* @param next Next handler.
* @return A new route definition.
*/
@Nonnull
default Route.Collection complete(final Route.Complete handler, Route.Complete... next) {
return complete("*", handler, next);
}
/**
* {@code
* {
* complete("*", (req, rsp, cause) -> {
* // your code goes here
* });
* }
* }
*
* You are NOT allowed to modify the request and response objects. The cause is an
* {@link Optional} with a {@link Throwable} useful to identify problems.
*
* The goal of the complete handler is to probably cleanup request object and log
* responses.
*
* A complete handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* complete("/path", (req, rsp, cause) -> {
* // your code goes here
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* *
* Suppose you have a transactional resource, like a database connection. The next example shows
* you how to implement a simple and effective transaction-per-request pattern:
*
{@code
* {
* // start transaction
* before("/api/*", (req, rsp) -> {
* DataSource ds = req.require(DataSource.class);
* Connection connection = ds.getConnection();
* Transaction trx = connection.getTransaction();
* trx.begin();
* req.set("connection", connection);
* return true;
* });
*
* // commit/rollback transaction
* complete("/api/*", (req, rsp, cause) -> {
* // unbind connection from request
* try(Connection connection = req.unset("connection").get()) {
* Transaction trx = connection.getTransaction();
* if (cause.ifPresent()) {
* trx.rollback();
* } else {
* trx.commit();
* }
* }
* });
*
* // your transactional routes goes here
* get("/api/something", req -> {
* Connection connection = req.get("connection");
* // work with connection
* });
* }
* }
*
* @param pattern Pattern to intercept.
* @param handler Complete handler.
* @return A new route definition.
*/
@Nonnull
default Route.Definition complete(final String pattern, final Route.Complete handler) {
return complete("*", pattern, handler);
}
/**
* {@code
* {
* complete("*", (req, rsp, cause) -> {
* // your code goes here
* });
* }
* }
*
* You are NOT allowed to modify the request and response objects. The cause is an
* {@link Optional} with a {@link Throwable} useful to identify problems.
*
* The goal of the complete handler is to probably cleanup request object and log
* responses.
*
* A complete handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* complete("/path", (req, rsp, cause) -> {
* // your code goes here
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* *
* Suppose you have a transactional resource, like a database connection. The next example shows
* you how to implement a simple and effective transaction-per-request pattern:
*
{@code
* {
* // start transaction
* before("/api/*", (req, rsp) -> {
* DataSource ds = req.require(DataSource.class);
* Connection connection = ds.getConnection();
* Transaction trx = connection.getTransaction();
* trx.begin();
* req.set("connection", connection);
* return true;
* });
*
* // commit/rollback transaction
* complete("/api/*", (req, rsp, cause) -> {
* // unbind connection from request
* try(Connection connection = req.unset("connection").get()) {
* Transaction trx = connection.getTransaction();
* if (cause.ifPresent()) {
* trx.rollback();
* } else {
* trx.commit();
* }
* }
* });
*
* // your transactional routes goes here
* get("/api/something", req -> {
* Connection connection = req.get("connection");
* // work with connection
* });
* }
* }
*
* @param pattern Pattern to intercept.
* @param handler Complete handler.
* @param next Next handler.
* @return A new route definition.
*/
@Nonnull
default Route.Collection complete(String pattern, Route.Complete handler, Route.Complete... next) {
return complete("*", pattern, handler, next);
}
/**
* {@code
* {
* complete("*", "*", (req, rsp, cause) -> {
* // your code goes here
* });
* }
* }
*
* You are NOT allowed to modify the request and response objects. The cause is an
* {@link Optional} with a {@link Throwable} useful to identify problems.
*
* The goal of the complete handler is to probably cleanup request object and log
* responses.
*
* A complete handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* complete("*", "/path", (req, rsp, cause) -> {
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* *
* Suppose you have a transactional resource, like a database connection. The next example shows
* you how to implement a simple and effective transaction-per-request pattern:
*
{@code
* {
* // start transaction
* before((req, rsp) -> {
* DataSource ds = req.require(DataSource.class);
* Connection connection = ds.getConnection();
* Transaction trx = connection.getTransaction();
* trx.begin();
* req.set("connection", connection);
* return true;
* });
*
* // commit/rollback transaction
* complete((req, rsp, cause) -> {
* // unbind connection from request
* try(Connection connection = req.unset("connection")) {
* Transaction trx = connection.getTransaction();
* if (cause.ifPresent()) {
* trx.rollback();
* } else {
* trx.commit();
* }
* }
* });
*
* // your transactional routes goes here
* get("/my-trx-route", req -> {
* Connection connection = req.get("connection");
* // work with connection
* });
* }
* }
*
* @param method HTTP method to intercept.
* @param pattern Pattern to intercept.
* @param handler Complete handler.
* @return A new route definition.
*/
@Nonnull
Route.Definition complete(String method, String pattern, Route.Complete handler);
/**
* {@code
* {
* complete("*", "*", (req, rsp, cause) -> {
* // your code goes here
* });
* }
* }
*
* You are NOT allowed to modify the request and response objects. The cause is an
* {@link Optional} with a {@link Throwable} useful to identify problems.
*
* The goal of the complete handler is to probably cleanup request object and log
* responses.
*
* A complete handler must to be registered before the actual handler you want to
* intercept.
*
* {@code
* {
* complete("*", "/path", (req, rsp, cause) -> {
* });
*
* get("/path", req -> {
* return "hello";
* });
* }
* }
*
* If you reverse the order then it won't work.
*
* * Remember: routes are executed in the order they are defined and the pipeline * is executed as long you don't generate a response. *
* *
* Suppose you have a transactional resource, like a database connection. The next example shows
* you how to implement a simple and effective transaction-per-request pattern:
*
{@code
* {
* // start transaction
* before((req, rsp) -> {
* DataSource ds = req.require(DataSource.class);
* Connection connection = ds.getConnection();
* Transaction trx = connection.getTransaction();
* trx.begin();
* req.set("connection", connection);
* return true;
* });
*
* // commit/rollback transaction
* complete((req, rsp, cause) -> {
* // unbind connection from request
* try(Connection connection = req.unset("connection")) {
* Transaction trx = connection.getTransaction();
* if (cause.ifPresent()) {
* trx.rollback();
* } else {
* trx.commit();
* }
* }
* });
*
* // your transactional routes goes here
* get("/my-trx-route", req -> {
* Connection connection = req.get("connection");
* // work with connection
* });
* }
* }
*
* @param method HTTP method to intercept.
* @param pattern Pattern to intercept.
* @param handler Complete handler.
* @param next Next handler.
* @return A new route definition.
*/
@Nonnull
default Route.Collection complete(String method, String pattern, Route.Complete handler, Route.Complete... next) {
List
* ws("/ws", (socket) {@literal ->} {
* // connected
* socket.onMessage(message {@literal ->} {
* System.out.println(message);
* });
* socket.send("Connected"):
* });
*
*
* @param path A path pattern.
* @param handler A connect callback.
* @return A new WebSocket definition.
*/
@Nonnull
default WebSocket.Definition ws(final String path, final WebSocket.OnOpen1 handler) {
return ws(path, (WebSocket.OnOpen) handler);
}
/**
* Append a new WebSocket handler under the given path.
*
*
* ws("/ws", (req, socket) {@literal ->} {
* // connected
* socket.onMessage(message {@literal ->} {
* System.out.println(message);
* });
* socket.send("Connected"):
* });
*
*
* @param path A path pattern.
* @param handler A connect callback.
* @return A new WebSocket definition.
*/
@Nonnull
WebSocket.Definition ws(String path, WebSocket.OnOpen handler);
/**
* Append a new WebSocket handler under the given path.
*
* * ws(MyHandler.class); ** * @param handler A message callback. * @param
* ws("/ws", MyHandler.class);
*
*
* @param path A path pattern.
* @param handler A message callback.
* @param {@code
* {
* sse("/path",(req, sse) -> {
* // 1. connected
* sse.send("data"); // 2. send/push data
* });
* }
* }
*
* @param path Event path.
* @param handler Callback. It might executed in a different thread (web server choice).
* @return A route definition.
*/
@Nonnull
Route.Definition sse(String path, Sse.Handler handler);
/**
* Add a server-sent event handler.
*
* {@code
* {
* sse("/path", sse -> {
* // 1. connected
* sse.send("data"); // 2. send/push data
* });
* }
* }
*
* @param path Event path.
* @param handler Callback. It might executed in a different thread (web server choice).
* @return A route definition.
*/
@Nonnull
Route.Definition sse(String path, Sse.Handler1 handler);
/**
* Apply common configuration and attributes to a group of routes:
*
* {@code
* {
* with(() -> {
* get("/foo", ...);
*
* get("/bar", ...);
*
* get("/etc", ...);
*
* ...
* }).attr("v1", "k1")
* .excludes("/public/**");
* }
* }
*
* All the routes wrapped by with will have a v1 attribute and will
* excludes/ignores a /public request.
*
* @param callback Route callback.
* @return A route collection.
*/
@Nonnull
Route.Collection with(Runnable callback);
/**
* Apply the mapper to all the functional routes.
*
* {@code
* {
* mapper((Integer v) -> v * 2);
*
* mapper(v -> Integer.parseInt(v.toString()));
*
* get("/four", () -> "2");
* }
* }
*
* A call to /four outputs 4. Mapper are applied in reverse order.
*
* @param mapper Route mapper to append.
* @return This instance.
*/
@Nonnull
Router map(final Mapper mapper);
/**
* Setup a route error handler. Default error handler {@link Err.DefHandler} does content
* negotation and this method allow to override/complement default handler.
*
* This is a catch all error handler.
*
* text/html header. Then, the default err handler will
* ask to a {@link View.Engine} to render the err view.
*
* The default model has these attributes:
* * message: exception string * stacktrace: exception stack-trace as an array of string * status: status code, like 400 * reason: status code reason, like BAD REQUEST ** * Here is a simply
public/err.html error page:
*
*
* <html>
* <body>
* {{ "{{status" }}}}:{{ "{{reason" }}}}
* </body>
* </html>
*
*
* HTTP status code will be set too.
*
* @param err A route error handler.
* @return This router.
*/
@Nonnull
Router err(Err.Handler err);
/**
* Setup a custom error handler.The error handler will be executed if the current exception is an
* instance of given type type.
*
* All headers are reset while generating the error response.
*
* @param type Exception type. The error handler will be executed if the current exception is an
* instance of this type.
* @param handler A route error handler.
* @return This router.
*/
@Nonnull
default Router err(final Class type, final Err.Handler handler) {
return err((req, rsp, x) -> {
if (type.isInstance(x) || type.isInstance(x.getCause())) {
handler.handle(req, rsp, x);
}
});
}
/**
* Setup a route error handler. The error handler will be executed if current status code matches
* the one provided.
*
* All headers are reset while generating the error response.
*
* @param statusCode The status code to match.
* @param handler A route error handler.
* @return This router.
*/
@Nonnull
default Router err(final int statusCode, final Err.Handler handler) {
return err((req, rsp, x) -> {
if (statusCode == x.statusCode()) {
handler.handle(req, rsp, x);
}
});
}
/**
* Setup a route error handler. The error handler will be executed if current status code matches
* the one provided.
*
* All headers are reset while generating the error response.
*
* @param code The status code to match.
* @param handler A route error handler.
* @return This router.
*/
@Nonnull
default Router err(final Status code, final Err.Handler handler) {
return err((req, rsp, x) -> {
if (code.value() == x.statusCode()) {
handler.handle(req, rsp, x);
}
});
}
/**
* Setup a route error handler. The error handler will be executed if current status code matches
* the one provided.
*
* All headers are reset while generating the error response.
*
* @param predicate Apply the error handler if the predicate evaluates to true.
* @param handler A route error handler.
* @return This router.
*/
@Nonnull
default Router err(final Predicate100 worker threads, defined by the property:
* server.threads.Max.
*
* That's why a {@link Deferred} result runs in the current thread (no need to use a new thread),
* unless you want to apply a different thread model and or use a reactive/async library.
*
* As a final thought you might want to reduce the number of worker thread if you are going to a
* build a full reactive/async application.
*
*
* {
* get("/async", promise(deferred {@literal ->} {
* try {
* deferred.resolve(...); // success value
* } catch (Exception ex) {
* deferred.reject(ex); // error value
* }
* }));
* }
*
*
* * This method is useful for integrating reactive/async libraries. Here is an example on how to * use RxJava: *
* *{@code
* {
* get("/rx", promise(deferred -> {
* Observable.create(s -> {
* s.onNext(...);
* s.onCompleted();
* }).subscribeOn(Schedulers.computation())
* .subscribe(deferred::resolve, deferred::reject);
* }));
* }
* }
*
* * This is just an example because there is a Rx module. *
* ** Checkout the {@link #deferred(org.jooby.Route.ZeroArgHandler)} methods to see how to use a * plain {@link Executor}. *
* * @param initializer Deferred initializer. * @return A new deferred handler. * @see Deferred */ @Nonnull Route.OneArgHandler promise(Deferred.Initializer initializer); /** * Produces a deferred response, useful for async request processing. Like * {@link #promise(org.jooby.Deferred.Initializer)} but allow you to specify an {@link Executor} * to use. See {@link Jooby#executor(Executor)} and {@link Jooby#executor(String, Executor)}. * *
* {
* executor("forkjoin", new ForkJoinPool());
*
* get("/async", promise("forkjoin", deferred {@literal ->} {
* try {
* deferred.resolve(...); // success value
* } catch (Exception ex) {
* deferred.reject(ex); // error value
* }
* }));
* }
*
*
* * Checkout the {@link #deferred(org.jooby.Route.ZeroArgHandler)} methods to see how to use a * plain {@link Executor}. *
* * @param executor Executor to run the deferred. * @param initializer Deferred initializer. * @return A new deferred handler. * @see Deferred */ @Nonnull Route.OneArgHandler promise(String executor, Deferred.Initializer initializer); /** * Produces a deferred response, useful for async request processing. Like * {@link #promise(org.jooby.Deferred.Initializer)} but give you access to {@link Request}. * *
* {
* ExecutorService executor = ...;
*
* get("/async", promise((req, deferred) {@literal ->} {
* executor.execute(() {@literal ->} {
* try {
* deferred.resolve(req.param("param").value()); // success value
* } catch (Exception ex) {
* deferred.reject(ex); // error value
* }
* });
* }));
* }
*
*
* @param initializer Deferred initializer.
* @return A new deferred handler.
* @see Deferred
*/
@Nonnull
Route.OneArgHandler promise(Deferred.Initializer0 initializer);
/**
* Produces a deferred response, useful for async request processing. Like
* {@link #promise(String, org.jooby.Deferred.Initializer)} but give you access to
* {@link Request}.
*
*
* {
* get("/async", promise("myexec", (req, deferred) {@literal ->} {
* // resolve a success value
* deferred.resolve(req.param("param").value());
* }));
* }
*
*
* @param executor Executor to run the deferred.
* @param initializer Deferred initializer.
* @return A new deferred handler.
* @see Deferred
*/
@Nonnull
Route.OneArgHandler promise(String executor, Deferred.Initializer0 initializer);
/**
* Functional version of {@link #promise(org.jooby.Deferred.Initializer)}. To use ideally with one
* or more {@link Executor}:
*
* {@code
* {
* executor("cached", Executors.newCachedExecutor());
*
* get("/fork", deferred("cached", req -> {
* return req.param("value").value();
* }));
* }
* }
*
* This handler automatically {@link Deferred#resolve(Object)} or
* {@link Deferred#reject(Throwable)} a route handler response.
*
* @param executor Executor to run the deferred.
* @param handler Application block.
* @return A new deferred handler.
*/
@Nonnull
default Route.ZeroArgHandler deferred(final String executor, final Route.OneArgHandler handler) {
return () -> Deferred.deferred(executor, handler);
}
/**
* Functional version of {@link #promise(org.jooby.Deferred.Initializer)}.
*
* Using the default executor (current thread):
*
* {@code
* {
* get("/fork", deferred(req -> {
* return req.param("value").value();
* }));
* }
* }
*
* Using a custom executor:
*
* {@code
* {
* executor(new ForkJoinPool());
*
* get("/fork", deferred(req -> {
* return req.param("value").value();
* }));
* }
* }
*
* This handler automatically {@link Deferred#resolve(Object)} or
* {@link Deferred#reject(Throwable)} a route handler response.
*
* @param handler Application block.
* @return A new deferred handler.
*/
@Nonnull
default Route.ZeroArgHandler deferred(final Route.OneArgHandler handler) {
return () -> Deferred.deferred(handler);
}
/**
* Functional version of {@link #promise(org.jooby.Deferred.Initializer)}. To use ideally with one
* or more {@link Executor}:
*
* {@code
* {
* executor("cached", Executors.newCachedExecutor());
*
* get("/fork", deferred("cached", () -> {
* return "OK";
* }));
* }
* }
*
* This handler automatically {@link Deferred#resolve(Object)} or
* {@link Deferred#reject(Throwable)} a route handler response.
*
* @param executor Executor to run the deferred.
* @param handler Application block.
* @return A new deferred handler.
*/
@Nonnull
default Route.ZeroArgHandler deferred(final String executor, final Route.ZeroArgHandler handler) {
return () -> Deferred.deferred(executor, handler);
}
/**
* Functional version of {@link #promise(org.jooby.Deferred.Initializer)}.
*
* Using the default executor (current thread):
*
* {@code
* {
* get("/fork", deferred(() -> {
* return req.param("value").value();
* }));
* }
* }
*
* Using a custom executor:
*
* {@code
* {
* executor(new ForkJoinPool());
*
* get("/fork", deferred(() -> {
* return req.param("value").value();
* }));
* }
* }
*
* This handler automatically {@link Deferred#resolve(Object)} or
* {@link Deferred#reject(Throwable)} a route handler response.
*
* @param handler Application block.
* @return A new deferred handler.
*/
@Nonnull
default Route.ZeroArgHandler deferred(final Route.ZeroArgHandler handler) {
return () -> Deferred.deferred(handler);
}
}