org.jooby

Interface Route.Chain

Enclosing interface:

Route

public static interface Route.Chain

Chain of routes to be executed. It invokes the next route in the chain.

Since:

0.1.0

Author:

edgar

Method Summary

Modifier and Type	Method and Description
default void	next(Request req, Response rsp) Invokes the next route in the chain.
void	next(String prefix, Request req, Response rsp) Invokes the next route in the chain where Route.name() starts with the given prefix.
List<Route>	routes() All the pending/next routes from pipeline.

Method Detail

next

void next(@Nullable
          String prefix,
          Request req,
          Response rsp)
   throws Throwable

Invokes the next route in the chain where Route.name() starts with the given prefix.

Parameters:

prefix - Iterates over the route chain and keep routes that start with the given prefix.

req - A HTTP request.

rsp - A HTTP response.

Throws:

Throwable - If invocation goes wrong.

next

default void next(Request req,
                  Response rsp)
           throws Throwable

Invokes the next route in the chain.

Parameters:

req - A HTTP request.

rsp - A HTTP response.

Throws:

Throwable - If invocation goes wrong.

routes

List<Route> routes()

All the pending/next routes from pipeline. Example:

   use("*", (req, rsp, chain) -> {
     List<Route> routes = chain.routes();
     assertEquals(2, routes.size());
     assertEquals("/r2", routes.get(0).name());
     assertEquals("/r3", routes.get(1).name());
     assertEquals("/786/:id", routes.get(routes.size() - 1).pattern());

     chain.next(req, rsp);
   }).name("r1");

   use("/786/**", (req, rsp, chain) -> {
     List<Route> routes = chain.routes();
     assertEquals(1, routes.size());
     assertEquals("/r3", routes.get(0).name());
     assertEquals("/786/:id", routes.get(routes.size() - 1).pattern());
     chain.next(req, rsp);
   }).name("r2");

   get("/786/:id", req -> {
     return req.param("id").value();
   }).name("r3");
 

Returns:

Next routes in the pipeline or empty list.