org.jooby

Interface Route.Before

All Superinterfaces:

Route.Filter

Enclosing interface:

Route

public static interface Route.Before
extends Route.Filter

before

Allows for customized handler execution chains. It will be invoked before the actual handler.

 {
   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 Route.Filter. For example, the before handler was implemented as:

 {
   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.

 {
   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.

Since:

1.0.0.CR

Author:

edgar

Method Summary

Modifier and Type	Method and Description
void	handle(Request req, Response rsp) Allows for customized handler execution chains.
default void	handle(Request req, Response rsp, Route.Chain chain) The handle method of the Filter is called by the server each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.

Method Detail

handle

default void handle(Request req,
                    Response rsp,
                    Route.Chain chain)
             throws Throwable

Description copied from interface: Route.Filter

The handle method of the Filter is called by the server each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The Route.Chain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:

• Examine the request
• Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
• Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
• • Either invoke the next entity in the chain using the Route.Chain object (chain.next(req, rsp)),
  • or not pass on the request/response pair to the next entity in the filter chain to block the request processing
• Directly set headers on the response after invocation of the next entity in the filter chain.

Specified by:

handle in interface Route.Filter

Parameters:

req - A HTTP request.

rsp - A HTTP response.

chain - A route chain.

Throws:

Throwable - If something goes wrong.

handle

void handle(Request req,
            Response rsp)
     throws Throwable

Allows for customized handler execution chains. It will be invoked before the actual handler.

Parameters:

req - Request.

rsp - Response

Throws:

Throwable - If something goes wrong.