org.jooby.internal

Class RouteImpl

java.lang.Object

org.jooby.internal.RouteImpl

All Implemented Interfaces:

RouteWithFilter, Route, Route.Filter

public class RouteImpl
extends Object
implements RouteWithFilter

Nested Class Summary

Nested classes/interfaces inherited from interface org.jooby.Route

Route.After, Route.Before, Route.Chain, Route.Collection, Route.Complete, Route.Definition, Route.Filter, Route.Forwarding, Route.Group, Route.Handler, Route.Mapper<T>, Route.MethodHandler, Route.OneArgHandler, Route.Props<T extends Route.Props<T>>, Route.Source, Route.ZeroArgHandler

Field Summary

Fields inherited from interface org.jooby.Route

CONNECT, DELETE, GET, HEAD, KEY, METHODS, OPTIONS, OUT_OF_PATH, PATCH, POST, PUT, TRACE

Constructor Summary

Constructors

Constructor and Description
RouteImpl(Route.Filter filter, Route.Definition route, String method, String path, List<MediaType> produces, Map<Object,String> vars, Route.Mapper<?> mapper, Route.Source source)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	attributes()
List<MediaType>	consumes()
static RouteWithFilter	fallback(Route.Filter filter, String method, String path, String name, List<MediaType> produces)
boolean	glob() Indicates if the Route.pattern() contains a glob character, like ?, * or **.
void	handle(Request request, Response response, 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.
String	method()
String	name() Route's name, helpful for debugging but also to implement dynamic and advanced routing.
static RouteWithFilter	notFound(String method, String path)
String	path()
String	pattern()
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).
String	toString()
Map<Object,String>	vars() Path variables, either named or by index (capturing group).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jooby.Route

apply, attr, errpath, normalize, print, print, unerrpath

Constructor Detail

RouteImpl

public RouteImpl(Route.Filter filter,
                 Route.Definition route,
                 String method,
                 String path,
                 List<MediaType> produces,
                 Map<Object,String> vars,
                 Route.Mapper<?> mapper,
                 Route.Source source)

Method Detail

notFound

public static RouteWithFilter notFound(String method,
                                       String path)

fallback

public static RouteWithFilter fallback(Route.Filter filter,
                                       String method,
                                       String path,
                                       String name,
                                       List<MediaType> produces)

handle

public void handle(Request request,
                   Response response,
                   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:

request - A HTTP request.

response - A HTTP response.

chain - A route chain.

Throws:

Throwable - If something goes wrong.

attributes

public Map<String,Object> attributes()

Specified by:

attributes in interface Route

Returns:

All the available attributes in the execution chain.

path

public String path()

Specified by:

path in interface Route

Returns:

Current request path.

method

public String method()

Specified by:

method in interface Route

Returns:

Current HTTP method.

pattern

public String pattern()

Specified by:

pattern in interface Route

Returns:

The currently matched pattern.

name

public String name()

Description copied from interface: Route

Route's name, helpful for debugging but also to implement dynamic and advanced routing. See Route.Chain.next(String, Request, Response)

Specified by:

name in interface Route

Returns:

Route name, defaults to "anonymous"

vars

public Map<Object,String> vars()

Description copied from interface: Route

Path variables, either named or by index (capturing group).

   /path/:var
 

Variable var is accessible by name: var or index: 0.

Specified by:

vars in interface Route

Returns:

The currently matched path variables (if any).

consumes

public List<MediaType> consumes()

Specified by:

consumes in interface Route

Returns:

List all the types this route can consumes, defaults is: * / *.

produces

public List<MediaType> produces()

Specified by:

produces in interface Route

Returns:

List all the types this route can produces, defaults is: * / *.

glob

public boolean glob()

Description copied from interface: Route

Indicates if the Route.pattern() contains a glob character, like ?, * or **.

Specified by:

glob in interface Route

Returns:

Indicates if the Route.pattern() contains a glob charecter, like ?, * or **.

reverse

public String reverse(Map<String,Object> vars)

Description copied from interface: Route

Recreate a route path and apply the given variables.

Specified by:

reverse in interface Route

Parameters:

vars - Path variables.

Returns:

A route pattern.

reverse

public String reverse(Object... values)

Description copied from interface: Route

Recreate a route path and apply the given variables.

Specified by:

reverse in interface Route

Parameters:

values - Path variable values.

Returns:

A route pattern.

source

public Route.Source source()

Description copied from interface: Route

Source information (where the route was defined).

Specified by:

source in interface Route

Returns:

Source information (where the route was defined).

renderer

public String renderer()

Description copied from interface: Route

Explicit renderer to use or null.

Specified by:

renderer in interface Route

Returns:

Explicit renderer to use or null.

toString

public String toString()

Overrides:

toString in class Object