Router (jooby 2.9.6 API)

All Superinterfaces:

Registry

All Known Implementing Classes:

Jooby, RouterImpl
```
public interface Router
extends Registry
```
Routing DSL functions.

Since:

2.0.0

Author:

edgar

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Router.Match
Find route result.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Router.Match` Find route result.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DELETE` HTTP DELETE.
`static String`	`GET` HTTP GET.
`static String`	`HEAD` HTTP HEAD.
`static List<String>`	`METHODS` HTTP Methods.
`static String`	`OPTIONS` HTTP OPTIONS.
`static String`	`PATCH` HTTP PATCH.
`static String`	`POST` HTTP POST.
`static String`	`PUT` HTTP PUT.
`static String`	`SSE` Sever-Sent events.
`static String`	`TRACE` HTTP TRACE.
`static String`	`WS` Web socket.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Router`	`after(Route.After after)` Add an after route decorator to the route pipeline.
`default Route`	`assets(String pattern, AssetHandler handler)` Add a static resource handler.
`default Route`	`assets(String pattern, AssetSource... source)` Add a static resource handler.
`default Route`	`assets(String pattern, Path source)` Add a static resource handler.
`default Route`	`assets(String pattern, String source)` Add a static resource handler.
`default <T> T`	`attribute(String key)` Get an attribute by his key.
`default Router`	`attribute(String key, Object value)` Set an application attribute.
`Router`	`before(Route.Before before)` Add a before route decorator to the route pipeline.
`Router`	`converter(BeanConverter converter)` Add a custom bean value converter.
`Router`	`converter(ValueConverter converter)` Add a custom string value converter.
`Router`	`decoder(MediaType contentType, MessageDecoder decoder)` Register a decoder for the given content type.
`Router`	`decorator(Route.Decorator decorator)` Add a route decorator to the route pipeline.
`default Route`	`delete(String pattern, Route.Handler handler)` Add a HTTP DELETE handler.
`Router`	`dispatch(Executor executor, Runnable body)` Dispatch route pipeline to the given executor.
`Router`	`dispatch(Runnable body)` Dispatch route pipeline to the `getWorker()` worker thread pool.
`Router`	`domain(String domain, Router subrouter)` Enabled routes for specific domain.
`RouteSet`	`domain(String domain, Runnable body)` Enabled routes for specific domain.
`Router`	`encoder(MediaType contentType, MessageEncoder encoder)` Register a route response encoder.
`Router`	`encoder(MessageEncoder encoder)` Register a route response encoder.
`default Router`	`error(Class<? extends Throwable> type, ErrorHandler handler)` Add a custom error handler that matches the given exception type.
`Router`	`error(ErrorHandler handler)` Add a custom error handler.
`default Router`	`error(Predicate<StatusCode> predicate, ErrorHandler handler)` Add a custom error handler that matches the given predicate.
`default Router`	`error(StatusCode statusCode, ErrorHandler handler)` Add a custom error handler that matches the given status code.
`Router`	`errorCode(Class<? extends Throwable> type, StatusCode statusCode)` Map an exception type to a status code.
`StatusCode`	`errorCode(Throwable cause)` Computes the status code for the given exception.
`default Executor`	`executor(String name)` Get an executor from application registry.
`Router`	`executor(String name, Executor executor)` Put an executor into the application registry.
`static List<String>`	`expandOptionalVariables(String pattern)` Look for optional path parameter and expand the given pattern into multiple pattern.
`default Route`	`get(String pattern, Route.Handler handler)` Add a HTTP GET handler.
`Map<String,Object>`	`getAttributes()` Mutable map of application attributes.
`List<BeanConverter>`	`getBeanConverters()` Get all complex/bean value converters.
`com.typesafe.config.Config`	`getConfig()` Application configuration.
`String`	`getContextPath()` Get application context path (a.k.a as base path).
`List<ValueConverter>`	`getConverters()` Get all simple/string value converters.
`Environment`	`getEnvironment()` Application environment.
`ErrorHandler`	`getErrorHandler()` Get the error handler.
`Cookie`	`getFlashCookie()` Template for the flash cookie.
`List<Locale>`	`getLocales()` Returns the supported locales.
`org.slf4j.Logger`	`getLog()` Application logger.
`Set<RouterOption>`	`getRouterOptions()` Router options.
`List<Route>`	`getRoutes()` Returns all routes.
`ServerOptions`	`getServerOptions()` Available server options.
`ServiceRegistry`	`getServices()` Application service registry.
`SessionStore`	`getSessionStore()` Session store.
`Path`	`getTmpdir()` Application temporary directory.
`Executor`	`getWorker()` Returns the worker thread pool.
`default Route`	`head(String pattern, Route.Handler handler)` Add a HTTP HEAD handler.
`boolean`	`isTrustProxy()` When true handles X-Forwarded-* headers by updating the values on the current context to match what was sent in the header(s).
`static String`	`leadingSlash(String path)` Ensure path start with a `/`(leading slash).
`Router.Match`	`match(Context ctx)` Find a matching route using the given context.
`boolean`	`match(String method, String path)` Find a matching route using the given context.
`Router`	`mount(Predicate<Context> predicate, Router router)` Import routes from given router.
`RouteSet`	`mount(Predicate<Context> predicate, Runnable body)` Import routes from given action.
`Router`	`mount(Router router)` Import all routes from the given router.
`Router`	`mount(String path, Router router)` Import all routes from the given router and prefix them with the given path.
`Router`	`mvc(Class router)` Import all route method from the given controller class.
`<T> Router`	`mvc(Class<T> router, javax.inject.Provider<T> provider)` Import all route method from the given controller class.
`Router`	`mvc(Object router)` Import all route methods from given controller instance.
`static String`	`normalizePath(String path)` Normalize a path by removing consecutive `/`(slashes).
`static String`	`noTrailingSlash(String path)` Strip trailing slashes.
`default Route`	`options(String pattern, Route.Handler handler)` Add a HTTP OPTIONS handler.
`default Route`	`patch(String pattern, Route.Handler handler)` Add a HTTP PATCH handler.
`RouteSet`	`path(String pattern, Runnable body)` Group one or more routes under a common path prefix.
`static List<String>`	`pathKeys(String pattern)` Extract path keys from given path pattern.
`static List<String>`	`pathKeys(String pattern, BiConsumer<String,String> consumer)` Extract path keys from given path pattern.
`default Route`	`post(String pattern, Route.Handler handler)` Add a HTTP POST handler.
`default Route`	`put(String pattern, Route.Handler handler)` Add a HTTP PUT handler.
`Router`	`responseHandler(ResponseHandler factory)` Add a response handler factory.
`static String`	`reverse(String pattern, Map<String,Object> keys)` Recreate a path pattern using the given variables.
`static String`	`reverse(String pattern, Object... values)` Recreate a path pattern using the given variables.
`Route`	`route(String method, String pattern, Route.Handler handler)` Add a route.
`RouteSet`	`routes(Runnable body)` Group one or more routes.
`Router`	`setContextAsService(boolean contextAsService)` If enabled, allows to retrieve the `Context` object associated with the current request via the service registry while the request is being processed.
`Router`	`setContextPath(String contextPath)` Set application context path.
`Router`	`setCurrentUser(Function<Context,Object> provider)` Provides a way to set the current user from a `Context`.
`Router`	`setDefaultWorker(Executor worker)` Set the default worker thread pool.
`Router`	`setFlashCookie(Cookie flashCookie)` Sets a cookie used as a template to generate the flash cookie, allowing to customize the cookie name and other cookie parameters.
`Router`	`setFlashCookie(String name)` Deprecated. Use `setFlashCookie(Cookie)` instead.
`Router`	`setHiddenMethod(Function<Context,Optional<String>> provider)` Provides a way to override the current HTTP method using lookup strategy.
`Router`	`setHiddenMethod(String parameterName)` Provides a way to override the current HTTP method.
`Router`	`setRouterOptions(RouterOption... options)` Set router options.
`Router`	`setSessionStore(SessionStore store)` Set session store.
`Router`	`setTrustProxy(boolean trustProxy)` When true handles X-Forwarded-* headers by updating the values on the current context to match what was sent in the header(s).
`Router`	`setWorker(Executor worker)` Set a worker thread pool.
`Route`	`sse(String pattern, ServerSentEmitter.Handler handler)` Add a server-sent event handler.
`default Route`	`trace(String pattern, Route.Handler handler)` Add a HTTP TRACE handler.
`default Router`	`use(Predicate<Context> predicate, Router router)` Deprecated. Use `mount(Predicate, Router)`
`default RouteSet`	`use(Predicate<Context> predicate, Runnable body)` Deprecated. Use `mount(Predicate, Runnable)`
`default Router`	`use(Router router)` Deprecated. Use `mount(Router)`
`default Router`	`use(String path, Router router)` Deprecated. Use `mount(String, Router)`
`Route`	`ws(String pattern, WebSocket.Initializer handler)` Add a websocket handler.

Methods inherited from interface io.jooby.Registry
require, require, require

Field Detail
- GET
```
static final String GET
```
  HTTP GET.
  
  See Also:
  
  Constant Field Values
- POST
```
static final String POST
```
  HTTP POST.
  
  See Also:
  
  Constant Field Values
- PUT
```
static final String PUT
```
  HTTP PUT.
  
  See Also:
  
  Constant Field Values
- DELETE
```
static final String DELETE
```
  HTTP DELETE.
  
  See Also:
  
  Constant Field Values
- PATCH
```
static final String PATCH
```
  HTTP PATCH.
  
  See Also:
  
  Constant Field Values
- HEAD
```
static final String HEAD
```
  HTTP HEAD.
  
  See Also:
  
  Constant Field Values
- OPTIONS
```
static final String OPTIONS
```
  HTTP OPTIONS.
  
  See Also:
  
  Constant Field Values
- TRACE
```
static final String TRACE
```
  HTTP TRACE.
  
  See Also:
  
  Constant Field Values
- METHODS
```
static final List<String> METHODS
```
  HTTP Methods.
- WS
```
static final String WS
```
  Web socket.
  
  See Also:
  
  Constant Field Values
- SSE
```
static final String SSE
```
  Sever-Sent events.
  
  See Also:
  
  Constant Field Values

Method Detail

getConfig
```
@Nonnull
com.typesafe.config.Config getConfig()
```
Application configuration.

Returns:

Application configuration.

getEnvironment
```
@Nonnull
Environment getEnvironment()
```
Application environment.

Returns:

Application environment.

getLocales
```
@Nonnull
List<Locale> getLocales()
```
Returns the supported locales.

Returns:

The supported locales.

getAttributes
```
@Nonnull
Map<String,Object> getAttributes()
```
Mutable map of application attributes.

Returns:

Mutable map of application attributes.

attribute
```
@Nonnull
default <T> T attribute(@Nonnull
                                 String key)
```
Get an attribute by his key. This is just an utility method around getAttributes().

Type Parameters:

T - Attribute type.

Parameters:

key - Attribute key.

Returns:

Attribute value.

attribute

@Nonnull
default Router attribute(@Nonnull
                                  String key,
                                  Object value)

Set an application attribute.

Parameters:: key - Attribute key.; value - Attribute value.
Returns:: This router.

getServices
```
@Nonnull
ServiceRegistry getServices()
```
Application service registry. Services are accessible via this registry or Jooby.require(Class) calls. This method returns a mutable registry. You are free to modify/alter the registry.

Returns:

Service registry.

setContextPath
```
@Nonnull
Router setContextPath(@Nonnull
                               String contextPath)
```
Set application context path. Context path is the base path for all routes. Default is: /.

Parameters:

contextPath - Context path.

Returns:

This router.

getContextPath
```
@Nonnull
String getContextPath()
```
Get application context path (a.k.a as base path).

Returns:

Application context path (a.k.a as base path).

isTrustProxy
```
boolean isTrustProxy()
```
When true handles X-Forwarded-* headers by updating the values on the current context to match what was sent in the header(s). This should only be installed behind a reverse proxy that has been configured to send the X-Forwarded-* header, otherwise a remote user can spoof their address by sending a header with bogus values. The headers that are read/set are:
- X-Forwarded-For: Set/update the remote address Context.setRemoteAddress(String).
- X-Forwarded-Proto: Set/update request scheme Context.setScheme(String).
- X-Forwarded-Host: Set/update the request host Context.setHost(String).
- X-Forwarded-Port: Set/update the request port Context.setPort(int).
Returns:

True when enabled. Default is false.

setTrustProxy
```
@Nonnull
Router setTrustProxy(boolean trustProxy)
```
When true handles X-Forwarded-* headers by updating the values on the current context to match what was sent in the header(s). This should only be installed behind a reverse proxy that has been configured to send the X-Forwarded-* header, otherwise a remote user can spoof their address by sending a header with bogus values. The headers that are read/set are:
- X-Forwarded-For: Set/update the remote address Context.setRemoteAddress(String).
- X-Forwarded-Proto: Set/update request scheme Context.setScheme(String).
- X-Forwarded-Host: Set/update the request host Context.setHost(String).
- X-Forwarded-Port: Set/update the request port Context.setPort(int).
Parameters:

trustProxy - True to enabled.

Returns:

This router.

setHiddenMethod
```
@Nonnull
Router setHiddenMethod(@Nonnull
                                String parameterName)
```
Provides a way to override the current HTTP method. Request must be: - POST Form/multipart request For alternative strategy use the setHiddenMethod(Function) method.

Parameters:

parameterName - Form field name.

Returns:

This router.

setHiddenMethod

@Nonnull
Router setHiddenMethod(@Nonnull
                                Function<Context,Optional<String>> provider)

Provides a way to override the current HTTP method using lookup strategy.

Parameters:: provider - Lookup strategy.
Returns:: This router.

setCurrentUser
```
@Nonnull
Router setCurrentUser(@Nullable
                               Function<Context,Object> provider)
```
Provides a way to set the current user from a Context. Current user can be retrieve it using Context.getUser().

Parameters:

provider - User provider/factory.

Returns:

This router.

setContextAsService
```
@Nonnull
Router setContextAsService(boolean contextAsService)
```
If enabled, allows to retrieve the Context object associated with the current request via the service registry while the request is being processed.

Parameters:

contextAsService - whether to enable or disable this feature

Returns:

This router.

domain
```
@Nonnull
Router domain(@Nonnull
                       String domain,
                       @Nonnull
                       Router subrouter)
```
Enabled routes for specific domain. Domain matching is done using the host header.
```
 {
   domain("foo.com", new FooApp());
   domain("bar.com", new BarApp());
 }
 
```
NOTE: if you run behind a reverse proxy you might to enabled setTrustProxy(boolean). NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
Parameters:

domain - Predicate

subrouter - Subrouter.

Returns:

This router.

domain

@Nonnull
RouteSet domain(@Nonnull
                         String domain,
                         @Nonnull
                         Runnable body)

Enabled routes for specific domain. Domain matching is done using the host header.


 {
   domain("foo.com", () -> {
     get("/", ctx -> "foo");
   });
   domain("bar.com", () -> {
     get("/", ctx -> "bar");
   });
 }

NOTE: if you run behind a reverse proxy you might to enabled setTrustProxy(boolean).

Parameters:: domain - Predicate; body - Route action.
Returns:: This router.

use
```
@Deprecated
 @Nonnull
default Router use(@Nonnull
                                         Predicate<Context> predicate,
                                         @Nonnull
                                         Router router)
```
Deprecated. Use mount(Predicate, Router)
Import routes from given router. Predicate works like a filter and only when predicate pass the routes match against the current request. Example of domain predicate filter:
```
 {
   use(ctx -> ctx.getHost().equals("foo.com"), new FooApp());
   use(ctx -> ctx.getHost().equals("bar.com"), new BarApp());
 }
 
```
Imported routes are matched only when predicate pass. NOTE: if you run behind a reverse proxy you might to enabled setTrustProxy(boolean). NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
Parameters:

predicate - Context predicate.

router - Router to import.

Returns:

This router.

mount
```
@Nonnull
Router mount(@Nonnull
                      Predicate<Context> predicate,
                      @Nonnull
                      Router router)
```
Import routes from given router. Predicate works like a filter and only when predicate pass the routes match against the current request. Example of domain predicate filter:
```
 {
   use(ctx -> ctx.getHost().equals("foo.com"), new FooApp());
   use(ctx -> ctx.getHost().equals("bar.com"), new BarApp());
 }
 
```
Imported routes are matched only when predicate pass. NOTE: if you run behind a reverse proxy you might to enabled setTrustProxy(boolean). NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
Parameters:

predicate - Context predicate.

router - Router to import.

Returns:

This router.

use

@Deprecated
 @Nonnull
default RouteSet use(@Nonnull
                                           Predicate<Context> predicate,
                                           @Nonnull
                                           Runnable body)

Deprecated. Use mount(Predicate, Runnable)

Import routes from given action. Predicate works like a filter and only when predicate pass the routes match against the current request. Example of domain predicate filter:


 {
   use(ctx -> ctx.getHost().equals("foo.com"), () -> {
     get("/", ctx -> "foo");
   });
   use(ctx -> ctx.getHost().equals("bar.com"), () -> {
     get("/", ctx -> "bar");
   });
 }

NOTE: if you run behind a reverse proxy you might to enabled setTrustProxy(boolean).

Parameters:: predicate - Context predicate.; body - Route action.
Returns:: This router.

mount

@Nonnull
RouteSet mount(@Nonnull
                        Predicate<Context> predicate,
                        @Nonnull
                        Runnable body)

Import routes from given action. Predicate works like a filter and only when predicate pass the routes match against the current request. Example of domain predicate filter:


 {
   mount(ctx -> ctx.getHost().equals("foo.com"), () -> {
     get("/", ctx -> "foo");
   });
   mount(ctx -> ctx.getHost().equals("bar.com"), () -> {
     get("/", ctx -> "bar");
   });
 }

NOTE: if you run behind a reverse proxy you might to enabled setTrustProxy(boolean). NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.

Parameters:: predicate - Context predicate.; body - Route action.
Returns:: This router.

use

@Deprecated
 @Nonnull
default Router use(@Nonnull
                                         String path,
                                         @Nonnull
                                         Router router)

Deprecated. Use mount(String, Router)

Import all routes from the given router and prefix them with the given path. NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.

Parameters:: path - Prefix path.; router - Router to import.
Returns:: This router.

mount
```
@Nonnull
Router mount(@Nonnull
                      String path,
                      @Nonnull
                      Router router)
```
Import all routes from the given router and prefix them with the given path. NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.

Parameters:

path - Prefix path.

router - Router to import.

Returns:

This router.

use
```
@Deprecated
 @Nonnull
default Router use(@Nonnull
                                         Router router)
```
Deprecated. Use mount(Router)

Import all routes from the given router. NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.

Parameters:

router - Router to import.

Returns:

This router.

mount
```
@Nonnull
Router mount(@Nonnull
                      Router router)
```
Import all routes from the given router. NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.

Parameters:

router - Router to import.

Returns:

This router.

mvc
```
@Nonnull
Router mvc(@Nonnull
                    Class router)
```
Import all route method from the given controller class. At runtime the controller instance is resolved by calling Jooby.require(Class).

Parameters:

router - Controller class.

Returns:

This router.

mvc

@Nonnull
<T> Router mvc(@Nonnull
                        Class<T> router,
                        @Nonnull
                        javax.inject.Provider<T> provider)

Import all route method from the given controller class.

Type Parameters:: T - Controller type.
Parameters:: router - Controller class.; provider - Controller provider.
Returns:: This router.

mvc
```
@Nonnull
Router mvc(@Nonnull
                    Object router)
```
Import all route methods from given controller instance.

Parameters:

router - Controller instance.

Returns:

This routes.

ws

@Nonnull
Route ws(@Nonnull
                  String pattern,
                  @Nonnull
                  WebSocket.Initializer handler)

Add a websocket handler.

Parameters:: pattern - WebSocket path pattern.; handler - WebSocket handler.
Returns:: A new route.

sse

@Nonnull
Route sse(@Nonnull
                   String pattern,
                   @Nonnull
                   ServerSentEmitter.Handler handler)

Add a server-sent event handler.

Parameters:: pattern - Path pattern.; handler - Handler.
Returns:: A new route.

getRoutes
```
@Nonnull
List<Route> getRoutes()
```
Returns all routes.

Returns:

All routes.

encoder

@Nonnull
Router encoder(@Nonnull
                        MessageEncoder encoder)

Parameters:: encoder - MessageEncoder instance.
Returns:: This router.

encoder

@Nonnull
Router encoder(@Nonnull
                        MediaType contentType,
                        @Nonnull
                        MessageEncoder encoder)

Parameters:: contentType - Accept header should matches the content-type.; encoder - MessageEncoder instance.
Returns:: This router.

getTmpdir
```
@Nonnull
Path getTmpdir()
```
Application temporary directory. This method initialize the Environment when isn't set manually.

Returns:

Application temporary directory.

decoder

@Nonnull
Router decoder(@Nonnull
                        MediaType contentType,
                        @Nonnull
                        MessageDecoder decoder)

Parameters:: contentType - Content type to match.; decoder - MessageDecoder.
Returns:: This router.

getWorker
```
@Nonnull
Executor getWorker()
```
Returns the worker thread pool. This thread pool is used to run application blocking code.

Returns:

Worker thread pool.

setWorker
```
@Nonnull
Router setWorker(@Nonnull
                          Executor worker)
```
Set a worker thread pool. This thread pool is used to run application blocking code.

Parameters:

worker - Worker thread pool.

Returns:

This router.

setDefaultWorker
```
@Nonnull
Router setDefaultWorker(@Nonnull
                                 Executor worker)
```
Set the default worker thread pool. Via this method the underlying web server set/suggests the worker thread pool that should be used it. A call to getWorker() returns the default thread pool, unless you explicitly set one.

Parameters:

worker - Default worker thread pool.

Returns:

This router.

decorator

@Nonnull
Router decorator(@Nonnull
                          Route.Decorator decorator)

Add a route decorator to the route pipeline.

Parameters:: decorator - Decorator.
Returns:: This router.

before
```
@Nonnull
Router before(@Nonnull
                       Route.Before before)
```
Add a before route decorator to the route pipeline.

Parameters:

before - Before decorator.

Returns:

This router.

after
```
@Nonnull
Router after(@Nonnull
                      Route.After after)
```
Add an after route decorator to the route pipeline.

Parameters:

after - After decorator.

Returns:

This router.

dispatch
```
@Nonnull
Router dispatch(@Nonnull
                         Runnable body)
```
Dispatch route pipeline to the getWorker() worker thread pool. After dispatch application code is allowed to do blocking calls.

Parameters:

body - Dispatch body.

Returns:

This router.

dispatch
```
@Nonnull
Router dispatch(@Nonnull
                         Executor executor,
                         @Nonnull
                         Runnable body)
```
Dispatch route pipeline to the given executor. After dispatch application code is allowed to do blocking calls.

Parameters:

executor - Executor. ExecutorService instances automatically shutdown at application exit.

body - Dispatch body.

Returns:

This router.

routes
```
@Nonnull
RouteSet routes(@Nonnull
                         Runnable body)
```
Group one or more routes. Useful for applying cross cutting concerns to the enclosed routes.

Parameters:

body - Route body.

Returns:

All routes created.

path

@Nonnull
RouteSet path(@Nonnull
                       String pattern,
                       @Nonnull
                       Runnable body)

Group one or more routes under a common path prefix. Useful for applying cross cutting concerns to the enclosed routes.

Parameters:: pattern - Path pattern.; body - Route body.
Returns:: All routes created.

get

@Nonnull
default Route get(@Nonnull
                           String pattern,
                           @Nonnull
                           Route.Handler handler)

Add a HTTP GET handler.

Parameters:: pattern - Path pattern.; handler - Application code.
Returns:: A route.

post

@Nonnull
default Route post(@Nonnull
                            String pattern,
                            @Nonnull
                            Route.Handler handler)

Add a HTTP POST handler.

Parameters:: pattern - Path pattern.; handler - Application code.
Returns:: A route.

put

@Nonnull
default Route put(@Nonnull
                           String pattern,
                           @Nonnull
                           Route.Handler handler)

Add a HTTP PUT handler.

Parameters:: pattern - Path pattern.; handler - Application code.
Returns:: A route.

delete

@Nonnull
default Route delete(@Nonnull
                              String pattern,
                              @Nonnull
                              Route.Handler handler)

Add a HTTP DELETE handler.

Parameters:: pattern - Path pattern.; handler - Application code.
Returns:: A route.

patch

@Nonnull
default Route patch(@Nonnull
                             String pattern,
                             @Nonnull
                             Route.Handler handler)

Add a HTTP PATCH handler.

Parameters:: pattern - Path pattern.; handler - Application code.
Returns:: A route.

head

@Nonnull
default Route head(@Nonnull
                            String pattern,
                            @Nonnull
                            Route.Handler handler)

Add a HTTP HEAD handler.

Parameters:: pattern - Path pattern.; handler - Application code.
Returns:: A route.

options

@Nonnull
default Route options(@Nonnull
                               String pattern,
                               @Nonnull
                               Route.Handler handler)

Add a HTTP OPTIONS handler.

Parameters:: pattern - Path pattern.; handler - Application code.
Returns:: A route.

trace

@Nonnull
default Route trace(@Nonnull
                             String pattern,
                             @Nonnull
                             Route.Handler handler)

Add a HTTP TRACE handler.

Parameters:: pattern - Path pattern.; handler - Application code.
Returns:: A route.

assets

@Nonnull
default Route assets(@Nonnull
                              String pattern,
                              @Nonnull
                              Path source)

Add a static resource handler. Static resources are resolved from file system.

Parameters:: pattern - Path pattern.; source - File system directory.
Returns:: A route.

assets
```
@Nonnull
default Route assets(@Nonnull
                              String pattern,
                              @Nonnull
                              String source)
```
Add a static resource handler. Static resources are resolved from: - file-system if the source folder exists in the current user directory - or fallback to classpath when file-system folder doesn't exist. NOTE: This method choose file-system or classpath, it doesn't merge them.

Parameters:

pattern - Path pattern.

source - File-System folder when exists, or fallback to a classpath folder.

Returns:

A route.

assets

@Nonnull
default Route assets(@Nonnull
                              String pattern,
                              @Nonnull
                              AssetSource... source)

Add a static resource handler.

Parameters:: pattern - Path pattern.; source - Asset sources.
Returns:: A route.

assets

@Nonnull
default Route assets(@Nonnull
                              String pattern,
                              @Nonnull
                              AssetHandler handler)

Add a static resource handler.

Parameters:: pattern - Path pattern.; handler - Asset handler.
Returns:: A route.

route

@Nonnull
Route route(@Nonnull
                     String method,
                     @Nonnull
                     String pattern,
                     @Nonnull
                     Route.Handler handler)

Add a route.

Parameters:: method - HTTP method.; pattern - Path pattern.; handler - Application code.
Returns:: A route.

match
```
@Nonnull
Router.Match match(@Nonnull
                            Context ctx)
```
Find a matching route using the given context. If no match exists this method returns a route with a 404 handler. See Route.NOT_FOUND.

Parameters:

ctx - Web Context.

Returns:

A route match result.

match
```
boolean match(@Nonnull
              String method,
              @Nonnull
              String path)
```
Find a matching route using the given context. If no match exists this method returns a route with a 404 handler. See Route.NOT_FOUND.

Parameters:

method - Method to match.

path - Path to match.

Returns:

A route match result.

errorCode

@Nonnull
Router errorCode(@Nonnull
                          Class<? extends Throwable> type,
                          @Nonnull
                          StatusCode statusCode)

Map an exception type to a status code.

Parameters:: type - Exception type.; statusCode - Status code.
Returns:: This router.

errorCode

@Nonnull
StatusCode errorCode(@Nonnull
                              Throwable cause)

Computes the status code for the given exception.

Parameters:: cause - Exception.
Returns:: Status code.

error

@Nonnull
default Router error(@Nonnull
                              StatusCode statusCode,
                              @Nonnull
                              ErrorHandler handler)

Add a custom error handler that matches the given status code.

Parameters:: statusCode - Status code.; handler - Error handler.
Returns:: This router.

error

@Nonnull
default Router error(@Nonnull
                              Class<? extends Throwable> type,
                              @Nonnull
                              ErrorHandler handler)

Add a custom error handler that matches the given exception type.

Parameters:: type - Exception type.; handler - Error handler.
Returns:: This router.

error

@Nonnull
default Router error(@Nonnull
                              Predicate<StatusCode> predicate,
                              @Nonnull
                              ErrorHandler handler)

Add a custom error handler that matches the given predicate.

Parameters:: predicate - Status code filter.; handler - Error handler.
Returns:: This router.

error

@Nonnull
Router error(@Nonnull
                      ErrorHandler handler)

Add a custom error handler.

Parameters:: handler - Error handler.
Returns:: This router.

getErrorHandler
```
@Nonnull
ErrorHandler getErrorHandler()
```
Get the error handler.

Returns:

An error handler.

getLog
```
@Nonnull
org.slf4j.Logger getLog()
```
Application logger.

Returns:

Application logger.

responseHandler

@Nonnull
Router responseHandler(@Nonnull
                                ResponseHandler factory)

Add a response handler factory.

Parameters:: factory - Response handler factory.
Returns:: This router.

getRouterOptions
```
@Nonnull
Set<RouterOption> getRouterOptions()
```
Router options.

Returns:

Router options.

setRouterOptions

@Nonnull
Router setRouterOptions(@Nonnull
                                 RouterOption... options)

Set router options.

Parameters:: options - router options.
Returns:: This router.

getSessionStore
```
@Nonnull
SessionStore getSessionStore()
```
Session store. Default use a cookie ID with a memory storage. See SessionStore.memory().

Returns:

Session store.

setSessionStore

@Nonnull
Router setSessionStore(@Nonnull
                                SessionStore store)

Set session store.

Parameters:: store - Session store.
Returns:: This router.

executor

@Nonnull
default Executor executor(@Nonnull
                                   String name)

Get an executor from application registry.

Parameters:: name - Executor name.
Returns:: Executor.

executor

@Nonnull
Router executor(@Nonnull
                         String name,
                         @Nonnull
                         Executor executor)

Put an executor into the application registry.

Parameters:: name - Executor's name.; executor - Executor.
Returns:: This router.

setFlashCookie

@Deprecated
 @Nonnull
Router setFlashCookie(@Nonnull
                                            String name)

Deprecated. Use setFlashCookie(Cookie) instead.

Set flash cookie name.

Parameters:: name - Flash cookie name.
Returns:: This router.

getFlashCookie
```
@Nonnull
Cookie getFlashCookie()
```
Template for the flash cookie. Default name is: jooby.flash.

Returns:

Template for the flash cookie.

setFlashCookie
```
@Nonnull
Router setFlashCookie(@Nonnull
                               Cookie flashCookie)
```
Sets a cookie used as a template to generate the flash cookie, allowing to customize the cookie name and other cookie parameters.

Parameters:

flashCookie - The cookie template.

Returns:

This router.

converter

@Nonnull
Router converter(@Nonnull
                          ValueConverter converter)

Add a custom string value converter.

Parameters:: converter - Custom value converter.
Returns:: This router.

converter

@Nonnull
Router converter(@Nonnull
                          BeanConverter converter)

Add a custom bean value converter.

Parameters:: converter - Custom value converter.
Returns:: This router.

getConverters
```
@Nonnull
List<ValueConverter> getConverters()
```
Get all simple/string value converters.

Returns:

All simple/string value converters.

getBeanConverters
```
@Nonnull
List<BeanConverter> getBeanConverters()
```
Get all complex/bean value converters.

Returns:

All complex/bean value converters.

getServerOptions
```
@Nonnull
ServerOptions getServerOptions()
```
Available server options.

Returns:

Server options.

leadingSlash

@Nonnull
static String leadingSlash(@Nullable
                                    String path)

Ensure path start with a /(leading slash).

Parameters:: path - Path to process.
Returns:: Path with leading slash.

noTrailingSlash

@Nonnull
static String noTrailingSlash(@Nonnull
                                       String path)

Strip trailing slashes.

Parameters:: path - Path to process.
Returns:: Path without trailing slashes.

normalizePath

@Nonnull
static String normalizePath(@Nullable
                                     String path)

Normalize a path by removing consecutive /(slashes).

Parameters:: path - Path to process.
Returns:: Safe path pattern.

pathKeys

@Nonnull
static List<String> pathKeys(@Nonnull
                                      String pattern)

Extract path keys from given path pattern. A path key (a.k.a path variable) looks like:

/product/{id}

Parameters:: pattern - Path pattern.
Returns:: Path keys.

pathKeys

@Nonnull
static List<String> pathKeys(@Nonnull
                                      String pattern,
                                      BiConsumer<String,String> consumer)

Extract path keys from given path pattern. A path key (a.k.a path variable) looks like:

/product/{id}

Parameters:: pattern - Path pattern.; consumer - Listen for key and regex variables found.
Returns:: Path keys.

expandOptionalVariables

@Nonnull
static List<String> expandOptionalVariables(@Nonnull
                                                     String pattern)

Look for optional path parameter and expand the given pattern into multiple pattern.

   /path => [/path]
   /{id} => [/{id}]
   /path/{id} => [/path/{id}]

   /{id}? => [/, /{id}]
   /path/{id}? => [/path, /path/{id}]
   /path/{id}/{start}?/{end}? => [/path/{id}, /path/{id}/{start}, /path/{id}/{start}/{end}]
   /path/{id}?/suffix => [/path, /path/{id}, /path/suffix]

Parameters:: pattern - Pattern.
Returns:: One or more patterns.

reverse

@Nonnull
static String reverse(@Nonnull
                               String pattern,
                               @Nonnull
                               Object... values)

Recreate a path pattern using the given variables. Variable replacement is done using the current index.

Parameters:: pattern - Path pattern.; values - Path keys.
Returns:: Path.

reverse

@Nonnull
static String reverse(@Nonnull
                               String pattern,
                               @Nonnull
                               Map<String,Object> keys)

Recreate a path pattern using the given variables.

Parameters:: pattern - Path pattern.; keys - Path keys.
Returns:: Path.

Interface Router

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface io.jooby.Registry

Field Detail

GET

POST

PUT

DELETE

PATCH

HEAD

OPTIONS

TRACE

METHODS

WS

SSE

Method Detail

getConfig

getEnvironment

getLocales

getAttributes

attribute

attribute

getServices

setContextPath

getContextPath

isTrustProxy

setTrustProxy

setHiddenMethod

setHiddenMethod

setCurrentUser

setContextAsService

domain

domain

use

mount

use

mount

use

mount

use

mount

mvc

mvc

mvc

ws

sse

getRoutes

encoder

encoder

getTmpdir

decoder

getWorker

setWorker

setDefaultWorker

decorator

before

after

dispatch

dispatch

routes

path

get

post

put

delete

patch

head

options

trace

assets

assets

assets

assets

route

match

match

errorCode

errorCode