Route (jooby-project 1.6.6 API)

All Known Implementing Classes:

Route.Forwarding
```
public interface Route
```
Routes are a key concept in Jooby. Routes are executed in the same order they are defined.
handlers

There are few type of handlers: Route.Handler, Route.OneArgHandler Route.ZeroArgHandler and Route.Filter. They behave very similar, except that a Route.Filter can decide if the next route handler can be executed or not. For example:
```
   get("/filter", (req, rsp, chain)  -> {
     if (someCondition) {
       chain.next(req, rsp);
     } else {
       // respond, throw err, etc...
     }
   });
 
```
While a Route.Handler always execute the next handler:
```
   get("/path", (req, rsp)  -> {
     rsp.send("handler");
   });

   // filter version
   get("/path", (req, rsp, chain)  -> {
     rsp.send("handler");
     chain.next(req, rsp);
   });
 
```
The Route.OneArgHandler and Route.ZeroArgHandler offers a functional version of generating a response:
```
 {
   get("/path", req -> "handler");

   get("/path", () -> "handler");
 }
 
```
There is no need to call Response.send(Object).
path patterns

Jooby supports Ant-style path patterns:

Some examples:
- com/t?st.html - matches com/test.html but also com/tast.jsp or com/txst.html
- com/*.html - matches all .html files in the com directory
- com/**/test.html - matches all test.html files underneath the com path
- **/* - matches any path at any level.
- * - matches any path at any level, shorthand for **/*.
variables

Jooby supports path parameters too:

Some examples:
- /user/{id} - /user/* and give you access to the id var.
- /user/:id - /user/* and give you access to the id var.
- /user/{id:\\d+} - /user/[digits] and give you access to the numeric id var.
routes semantic

Routes are executed in the order they are defined, for example:
```
   get("/", (req, rsp)  -> {
     log.info("first"); // start here and go to second
   });

   get("/", (req, rsp)  -> {
     log.info("second"); // execute after first and go to final
   });

   get("/", (req, rsp)  -> {
     rsp.send("final"); // done!
   });
 
```
Please note first and second routes are converted to a filter, so previous example is the same as:
```
   get("/", (req, rsp, chain)  -> {
     log.info("first"); // start here and go to second
     chain.next(req, rsp);
   });

   get("/", (req, rsp, chain)  -> {
     log.info("second"); // execute after first and go to final
     chain.next(req, rsp);
   });

   get("/", (req, rsp)  -> {
     rsp.send("final"); // done!
   });
 
```
script route

A script route can be defined using Lambda expressions, like:
```
   get("/", (request, response)  -> {
     response.send("Hello Jooby");
   });
 
```
Due to the use of lambdas a route is a singleton and you should NOT use global variables. For example this is a bad practice:
```
  List <String > names = new ArrayList <>(); // names produces side effects
  get("/", (req, rsp)  -> {
     names.add(req.param("name").value();
     // response will be different between calls.
     rsp.send(names);
   });
 
```
mvc Route

A Mvc Route use annotations to define routes:
```
 {
   use(MyRoute.class);
 }
 
```
MyRoute.java:
```
    @Path("/")
   public class MyRoute {

     @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 Path, Produces Consumes.
Since:

0.1.0

Author:

edgar

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Route.After` after
`static class`	`Route.AssetDefinition` Allow to customize an asset handler.
`static interface`	`Route.Before` before
`static interface`	`Route.Chain` Chain of routes to be executed.
`static class`	`Route.Collection` Collection of `Route.Props` useful for registering/setting route options at once.
`static interface`	`Route.Complete` complete
`static class`	`Route.Definition` DSL for customize routes.
`static interface`	`Route.Filter` The most advanced route handler which let you decided if the next route handler in the chain can be executed or not.
`static class`	`Route.Forwarding` A forwarding route.
`static interface`	`Route.Handler` A route handler that always call `Route.Chain.next(Request, Response)`.
`static interface`	`Route.Mapper<T>` Converts a route output to something else, see `Router#map(Mapper)`.
`static interface`	`Route.MethodHandler` A handler for a MVC route, it extends `Route.Handler` by adding a reference to the method and class behind this route.
`static interface`	`Route.OneArgHandler` A functional route handler that use the return value as HTTP response.
`static interface`	`Route.Props<T extends Route.Props<T>>` Common route properties, like static and global metadata via attributes, path exclusion, produces and consumes types.
`static interface`	`Route.Source` Provides useful information about where the route was defined.
`static interface`	`Route.ZeroArgHandler` A functional handler that use the return value as HTTP response.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONNECT`
`static String`	`DELETE`
`static String`	`GET`
`static String`	`HEAD`
`static com.google.inject.Key<Set<Route.Definition>>`	`KEY` Route key.
`static List<String>`	`METHODS` Well known HTTP methods.
`static String`	`OPTIONS`
`static char`	`OUT_OF_PATH`
`static String`	`PATCH`
`static String`	`POST`
`static String`	`PUT`
`static String`	`TRACE`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`apply(String prefix)` True, when route's name starts with the given prefix.
`default <T> T`	`attr(String name)` Attribute by name.
`Map<String,Object>`	`attributes()`
`List<MediaType>`	`consumes()`
`static String`	`errpath(String path)` Mark a path as invalid.
`boolean`	`glob()` Indicates if the `pattern()` contains a glob character, like `?`, `` or `*`.
`String`	`method()`
`String`	`name()` Route's name, helpful for debugging but also to implement dynamic and advanced routing.
`static String`	`normalize(String path)` Normalize a path by removing double or trailing slashes.
`String`	`path()`
`String`	`pattern()`
`default String`	`print()` Print route information like: method, path, source, etc...
`default String`	`print(int indent)` Print route information like: method, path, source, etc...
`List<MediaType>`	`produces()`
`String`	`renderer()` Explicit renderer to use or `null`.
`String`	`reverse(Map<String,Object> vars)` Recreate a route path and apply the given variables.
`String`	`reverse(Object... values)` Recreate a route path and apply the given variables.
`Route.Source`	`source()` Source information (where the route was defined).
`static String`	`unerrpath(String path)` Remove invalid path mark when present.
`Map<Object,String>`	`vars()` Path variables, either named or by index (capturing group).

- Field Detail
  - KEY
```
static final com.google.inject.Key<Set<Route.Definition>> KEY
```
    Route key.
  - OUT_OF_PATH
```
static final char OUT_OF_PATH
```
    See Also:
    
    Constant Field Values
  - GET
```
static final String GET
```
    See Also:
    
    Constant Field Values
  - POST
```
static final String POST
```
    See Also:
    
    Constant Field Values
  - PUT
```
static final String PUT
```
    See Also:
    
    Constant Field Values
  - DELETE
```
static final String DELETE
```
    See Also:
    
    Constant Field Values
  - PATCH
```
static final String PATCH
```
    See Also:
    
    Constant Field Values
  - HEAD
```
static final String HEAD
```
    See Also:
    
    Constant Field Values
  - CONNECT
```
static final String CONNECT
```
    See Also:
    
    Constant Field Values
  - OPTIONS
```
static final String OPTIONS
```
    See Also:
    
    Constant Field Values
  - TRACE
```
static final String TRACE
```
    See Also:
    
    Constant Field Values
  - METHODS
```
static final List<String> METHODS
```
    Well known HTTP methods.
- Method Detail
  - path
```
@Nonnull
String path()
```
    Returns:
    
    Current request path.
  - method
```
@Nonnull
String method()
```
    Returns:
    
    Current HTTP method.
  - pattern
```
@Nonnull
String pattern()
```
    Returns:
    
    The currently matched pattern.
  - name
```
@Nonnull
String name()
```
    Route's name, helpful for debugging but also to implement dynamic and advanced routing. See Route.Chain.next(String, Request, Response)
    
    Returns:
    
    Route name, defaults to "anonymous"
  - vars
```
@Nonnull
Map<Object,String> vars()
```
    Path variables, either named or by index (capturing group).
```
   /path/:var
 
```
    Variable var is accessible by name: var or index: 0.
    Returns:
    
    The currently matched path variables (if any).
  - consumes
```
@Nonnull
List<MediaType> consumes()
```
    Returns:
    
    List all the types this route can consumes, defaults is: * / *.
  - produces
```
@Nonnull
List<MediaType> produces()
```
    Returns:
    
    List all the types this route can produces, defaults is: * / *.
  - apply
```
default boolean apply(String prefix)
```
    True, when route's name starts with the given prefix. Useful for dynamic routing. See Route.Chain.next(String, Request, Response)
    
    Parameters:
    
    prefix - Prefix to check for.
    
    Returns:
    
    True, when route's name starts with the given prefix.
  - attributes
```
@Nonnull
Map<String,Object> attributes()
```
    Returns:
    
    All the available attributes in the execution chain.
  - attr
```
@Nonnull
default <T> T attr(String name)
```
    Attribute by name.
    
    Type Parameters:
    
    T - Attribute's type.
    
    Parameters:
    
    name - Attribute's name.
    
    Returns:
    
    Attribute value.
  - renderer
```
@Nonnull
String renderer()
```
    Explicit renderer to use or null.
    
    Returns:
    
    Explicit renderer to use or null.
  - glob
```
boolean glob()
```
    Indicates if the pattern() contains a glob character, like ?, * or **.
    
    Returns:
    
    Indicates if the pattern() contains a glob charecter, like ?, * or **.
  - reverse
```
@Nonnull
String reverse(Map<String,Object> vars)
```
    Recreate a route path and apply the given variables.
    
    Parameters:
    
    vars - Path variables.
    
    Returns:
    
    A route pattern.
  - reverse
```
@Nonnull
String reverse(Object... values)
```
    Recreate a route path and apply the given variables.
    
    Parameters:
    
    values - Path variable values.
    
    Returns:
    
    A route pattern.
  - normalize
```
@Nonnull
static String normalize(String path)
```
    Normalize a path by removing double or trailing slashes.
    
    Parameters:
    
    path - A path to normalize.
    
    Returns:
    
    A normalized path.
  - unerrpath
```
@Nonnull
static String unerrpath(String path)
```
    Remove invalid path mark when present.
    
    Parameters:
    
    path - Path.
    
    Returns:
    
    Original path.
  - errpath
```
@Nonnull
static String errpath(String path)
```
    Mark a path as invalid.
    
    Parameters:
    
    path - Path.
    
    Returns:
    
    Invalid path.
  - source
```
@Nonnull
Route.Source source()
```
    Source information (where the route was defined).
    
    Returns:
    
    Source information (where the route was defined).
  - print
```
@Nonnull
default String print(int indent)
```
    Print route information like: method, path, source, etc... Useful for debugging.
    
    Parameters:
    
    indent - Indent level
    
    Returns:
    
    Output.
  - print
```
@Nonnull
default String print()
```
    Print route information like: method, path, source, etc... Useful for debugging.
    
    Returns:
    
    Output.

Interface Route

handlers

path patterns

variables

routes semantic

script route

mvc Route

Nested Class Summary

Field Summary

Method Summary

Field Detail

KEY

OUT_OF_PATH

GET

POST

PUT

DELETE

PATCH

HEAD

CONNECT

OPTIONS

TRACE

METHODS

Method Detail

path

method

pattern

name

vars

consumes

produces

apply

attributes

attr

renderer

glob

reverse

reverse

normalize

unerrpath

errpath

source

print

print