io.jooby

Interface Router

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.

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	TRACE HTTP TRACE.
static String	WS Web socket.

Method Summary

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) Add a static resource handler.
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	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.
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.
ErrorHandler	getErrorHandler() Get the error handler.
String	getFlashCookie() Name of the flash cookie.
org.slf4j.Logger	getLog() Application logger.
RouterOptions	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.
Router.Match	match(Context ctx) Find a matching route using the given context.
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, boolean ignoreCase, boolean ignoreTrailingSlash) Normalize a path by removing consecutive /(slashes), make it lower case and removing trailing slash.
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.
Router	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.
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.
Router	route(Runnable body) Group one or more routes.
Route	route(String method, String pattern, Route.Handler handler) Add a route.
Router	setContextPath(String contextPath) Set application context path.
Router	setDefaultWorker(Executor worker) Set the default worker thread pool.
Router	setFlashCookie(String name) Set flash cookie name.
Router	setRouterOptions(RouterOptions options) Set router options.
Router	setSessionStore(SessionStore store) Set session store.
Router	setWorker(Executor worker) Set a worker thread pool.
default Route	trace(String pattern, Route.Handler handler) Add a HTTP TRACE handler.
Router	use(Predicate<Context> predicate, Router router) Import routes from given router.
Router	use(Router router) Import all routes from the given router.
Router	use(String path, Router router) Import all routes from the given router and prefix them with the given path.
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

Method Detail

getConfig

@Nonnull
com.typesafe.config.Config getConfig()

Application configuration.

Returns:

Application configuration.

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

use

@Nonnull
Router use(@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.

Parameters:

predicate - Context predicate.

router - Router to import.

Returns:

This router.

use

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

Import all routes from the given router and prefix them with the given path.

Parameters:

path - Prefix path.

router - Router to import.

Returns:

This router.

use

@Nonnull
Router use(@Nonnull
                    Router router)

Import all routes from the given router.

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:

This route.

getRoutes

@Nonnull
List<Route> getRoutes()

Returns all routes.

Returns:

All routes.

encoder

@Nonnull
Router encoder(@Nonnull
                        MessageEncoder encoder)

Register a route response encoder.

Parameters:

encoder - MessageEncoder instance.

Returns:

This router.

encoder

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

Register a route response encoder.

Parameters:

contentType - Accept header should matches the content-type.

encoder - MessageEncoder instance.

Returns:

This router.

getTmpdir

@Nonnull
Path getTmpdir()

Application temporary directory.

Returns:

Application temporary directory.

decoder

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

Register a decoder for the given content type.

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.

route

@Nonnull
Router route(@Nonnull
                      Runnable body)

Group one or more routes. Useful for applying cross cutting concerns to the enclosed routes.

Parameters:

body - Route body.

Returns:

This router.

path

@Nonnull
Router 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:

This router.

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.

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)

Add a static resource handler. Static resources are resolved from root classpath.

Parameters:

pattern - Path pattern.

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.

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
RouterOptions getRouterOptions()

Router options.

Returns:

Router options.

setRouterOptions

@Nonnull
Router setRouterOptions(@Nonnull
                                 RouterOptions 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.

getFlashCookie

@Nonnull
String getFlashCookie()

Name of the flash cookie. Defaults is: jooby.flash.

Returns:

Name of the flash cookie. Defaults is: jooby.flash.

setFlashCookie

@Nonnull
Router setFlashCookie(@Nonnull
                               String name)

Set flash cookie name.

Parameters:

name - Flash cookie name.

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.

normalizePath

@Nonnull
static String normalizePath(@Nonnull
                                     String path,
                                     boolean ignoreCase,
                                     boolean ignoreTrailingSlash)

Normalize a path by removing consecutive /(slashes), make it lower case and removing trailing slash.

Parameters:

path - Path to process.

ignoreCase - True to make it lower case.

ignoreTrailingSlash - True to remove trailing slash.

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.