RouterImpl (jooby 2.14.2 API)

java.lang.Object
- io.jooby.internal.RouterImpl

All Implemented Interfaces:: Registry, Router

public class RouterImpl
extends Object
implements Router

Nested Class Summary
- Nested classes/interfaces inherited from interface io.jooby.Router
  Router.Match

Field Summary
- Fields inherited from interface io.jooby.Router
  DELETE, GET, HEAD, METHODS, OPTIONS, PATCH, POST, PUT, SSE, TRACE, WS

Constructor Summary

Constructors
Constructor and Description

RouterImpl(ClassLoader loader)

Constructors
Constructor and Description
`RouterImpl(ClassLoader loader)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Router`	`after(Route.After after)` Add an after route decorator to the route pipeline.
`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.
`void`	`destroy()`
`Router`	`dispatch(Executor executor, Runnable action)` Dispatch route pipeline to the given executor.
`Router`	`dispatch(Runnable body)` Dispatch route pipeline to the `Router.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.
`Router`	`error(ErrorHandler handler)` Add a custom error handler.
`Router`	`errorCode(Class<? extends Throwable> type, StatusCode statusCode)` Map an exception type to a status code.
`StatusCode`	`errorCode(Throwable x)` Computes the status code for the given exception.
`Router`	`executor(String name, Executor executor)` Put an executor into the application registry.
`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.
`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).
`Router.Match`	`match(Context ctx)` Find a matching route using the given context.
`boolean`	`match(String pattern, String path)` Find a matching route using the given context.
`Router`	`mount(Predicate<Context> predicate, Router subrouter)` 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.
`RouteSet`	`path(String pattern, Runnable action)` Group one or more routes under a common path prefix.
`<T> T`	`require(Class<T> type)` Provides an instance of the given type.
`<T> T`	`require(Class<T> type, String name)` Provides an instance of the given type where name matches it.
`<T> T`	`require(ServiceKey<T> key)` Provides an instance of the given type.
`Router`	`responseHandler(ResponseHandler handler)` Add a response handler factory.
`Route`	`route(String method, String pattern, Route.Handler handler)` Add a route.
`RouteSet`	`routes(Runnable action)` 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 basePath)` 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)` Set flash cookie name.
`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 sessionStore)` 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.
`Router`	`start(Jooby app)`
`String`	`toString()`
`Route`	`ws(String pattern, WebSocket.Initializer handler)` Add a websocket handler.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.jooby.Router
assets, assets, assets, assets, attribute, attribute, delete, error, error, error, executor, expandOptionalVariables, get, head, leadingSlash, normalizePath, noTrailingSlash, options, patch, pathKeys, pathKeys, post, put, reverse, reverse, trace, use, use, use, use

- Constructor Detail
  - RouterImpl
```
public RouterImpl(ClassLoader loader)
```
- Method Detail
  - getConfig
```
@Nonnull
public com.typesafe.config.Config getConfig()
```
    Description copied from interface: Router
    
    Application configuration.
    
    Specified by:
    
    getConfig in interface Router
    
    Returns:
    
    Application configuration.
  - getEnvironment
```
@Nonnull
public Environment getEnvironment()
```
    Description copied from interface: Router
    
    Application environment.
    
    Specified by:
    
    getEnvironment in interface Router
    
    Returns:
    
    Application environment.
  - getLocales
```
@Nonnull
public List<Locale> getLocales()
```
    Description copied from interface: Router
    
    Returns the supported locales.
    
    Specified by:
    
    getLocales in interface Router
    
    Returns:
    
    The supported locales.
  - getAttributes
```
@Nonnull
public Map<String,Object> getAttributes()
```
    Description copied from interface: Router
    
    Mutable map of application attributes.
    
    Specified by:
    
    getAttributes in interface Router
    
    Returns:
    
    Mutable map of application attributes.
  - getRouterOptions
```
@Nonnull
public Set<RouterOption> getRouterOptions()
```
    Description copied from interface: Router
    
    Router options.
    
    Specified by:
    
    getRouterOptions in interface Router
    
    Returns:
    
    Router options.
  - setRouterOptions
```
@Nonnull
public Router setRouterOptions(@Nonnull
                                        RouterOption... options)
```
    Description copied from interface: Router
    
    Set router options.
    
    Specified by:
    
    setRouterOptions in interface Router
    
    Parameters:
    
    options - router options.
    
    Returns:
    
    This router.
  - setContextPath
```
@Nonnull
public Router setContextPath(@Nonnull
                                      String basePath)
```
    Description copied from interface: Router
    
    Set application context path. Context path is the base path for all routes. Default is: /.
    
    Specified by:
    
    setContextPath in interface Router
    
    Parameters:
    
    basePath - Context path.
    
    Returns:
    
    This router.
  - getTmpdir
```
@Nonnull
public Path getTmpdir()
```
    Description copied from interface: Router
    
    Application temporary directory. This method initialize the Environment when isn't set manually.
    
    Specified by:
    
    getTmpdir in interface Router
    
    Returns:
    
    Application temporary directory.
  - getContextPath
```
@Nonnull
public String getContextPath()
```
    Description copied from interface: Router
    
    Get application context path (a.k.a as base path).
    
    Specified by:
    
    getContextPath in interface Router
    
    Returns:
    
    Application context path (a.k.a as base path).
  - getRoutes
```
@Nonnull
public List<Route> getRoutes()
```
    Description copied from interface: Router
    
    Returns all routes.
    
    Specified by:
    
    getRoutes in interface Router
    
    Returns:
    
    All routes.
  - isTrustProxy
```
public boolean isTrustProxy()
```
    Description copied from interface: Router
    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).
    Specified by:
    
    isTrustProxy in interface Router
    
    Returns:
    
    True when enabled. Default is false.
  - setTrustProxy
```
@Nonnull
public Router setTrustProxy(boolean trustProxy)
```
    Description copied from interface: Router
    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).
    Specified by:
    
    setTrustProxy in interface Router
    
    Parameters:
    
    trustProxy - True to enabled.
    
    Returns:
    
    This router.
  - domain
```
@Nonnull
public RouteSet domain(@Nonnull
                                String domain,
                                @Nonnull
                                Runnable body)
```
    Description copied from interface: Router
    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 Router.setTrustProxy(boolean).
    Specified by:
    
    domain in interface Router
    
    Parameters:
    
    domain - Predicate
    
    body - Route action.
    
    Returns:
    
    This router.
  - domain
```
@Nonnull
public Router domain(@Nonnull
                              String domain,
                              @Nonnull
                              Router subrouter)
```
    Description copied from interface: Router
    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 Router.setTrustProxy(boolean). NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
    Specified by:
    
    domain in interface Router
    
    Parameters:
    
    domain - Predicate
    
    subrouter - Subrouter.
    
    Returns:
    
    This router.
  - mount
```
@Nonnull
public RouteSet mount(@Nonnull
                               Predicate<Context> predicate,
                               @Nonnull
                               Runnable body)
```
    Description copied from interface: Router
    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 Router.setTrustProxy(boolean). NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
    Specified by:
    
    mount in interface Router
    
    Parameters:
    
    predicate - Context predicate.
    
    body - Route action.
    
    Returns:
    
    This router.
  - mount
```
@Nonnull
public Router mount(@Nonnull
                             Predicate<Context> predicate,
                             @Nonnull
                             Router subrouter)
```
    Description copied from interface: 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 Router.setTrustProxy(boolean). NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
    Specified by:
    
    mount in interface Router
    
    Parameters:
    
    predicate - Context predicate.
    
    subrouter - Router to import.
    
    Returns:
    
    This router.
  - mount
```
@Nonnull
public Router mount(@Nonnull
                             String path,
                             @Nonnull
                             Router router)
```
    Description copied from interface: 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.
    
    Specified by:
    
    mount in interface Router
    
    Parameters:
    
    path - Prefix path.
    
    router - Router to import.
    
    Returns:
    
    This router.
  - mount
```
@Nonnull
public Router mount(@Nonnull
                             Router router)
```
    Description copied from interface: Router
    
    Import all routes from the given router. NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
    
    Specified by:
    
    mount in interface Router
    
    Parameters:
    
    router - Router to import.
    
    Returns:
    
    This router.
  - mvc
```
@Nonnull
public Router mvc(@Nonnull
                           Object router)
```
    Description copied from interface: Router
    
    Import all route methods from given controller instance.
    
    Specified by:
    
    mvc in interface Router
    
    Parameters:
    
    router - Controller instance.
    
    Returns:
    
    This routes.
  - mvc
```
@Nonnull
public Router mvc(@Nonnull
                           Class router)
```
    Description copied from interface: Router
    
    Import all route method from the given controller class. At runtime the controller instance is resolved by calling Jooby.require(Class).
    
    Specified by:
    
    mvc in interface Router
    
    Parameters:
    
    router - Controller class.
    
    Returns:
    
    This router.
  - mvc
```
@Nonnull
public <T> Router mvc(@Nonnull
                               Class<T> router,
                               @Nonnull
                               javax.inject.Provider<T> provider)
```
    Description copied from interface: Router
    
    Import all route method from the given controller class.
    
    Specified by:
    
    mvc in interface Router
    
    Type Parameters:
    
    T - Controller type.
    
    Parameters:
    
    router - Controller class.
    
    provider - Controller provider.
    
    Returns:
    
    This router.
  - encoder
```
@Nonnull
public Router encoder(@Nonnull
                               MessageEncoder encoder)
```
    Description copied from interface: Router
    
    Register a route response encoder.
    
    Specified by:
    
    encoder in interface Router
    
    Parameters:
    
    encoder - MessageEncoder instance.
    
    Returns:
    
    This router.
  - encoder
```
@Nonnull
public Router encoder(@Nonnull
                               MediaType contentType,
                               @Nonnull
                               MessageEncoder encoder)
```
    Description copied from interface: Router
    
    Register a route response encoder.
    
    Specified by:
    
    encoder in interface Router
    
    Parameters:
    
    contentType - Accept header should matches the content-type.
    
    encoder - MessageEncoder instance.
    
    Returns:
    
    This router.
  - decoder
```
@Nonnull
public Router decoder(@Nonnull
                               MediaType contentType,
                               @Nonnull
                               MessageDecoder decoder)
```
    Description copied from interface: Router
    
    Register a decoder for the given content type.
    
    Specified by:
    
    decoder in interface Router
    
    Parameters:
    
    contentType - Content type to match.
    
    decoder - MessageDecoder.
    
    Returns:
    
    This router.
  - getWorker
```
@Nonnull
public Executor getWorker()
```
    Description copied from interface: Router
    
    Returns the worker thread pool. This thread pool is used to run application blocking code.
    
    Specified by:
    
    getWorker in interface Router
    
    Returns:
    
    Worker thread pool.
  - setWorker
```
@Nonnull
public Router setWorker(Executor worker)
```
    Description copied from interface: Router
    
    Set a worker thread pool. This thread pool is used to run application blocking code.
    
    Specified by:
    
    setWorker in interface Router
    
    Parameters:
    
    worker - Worker thread pool.
    
    Returns:
    
    This router.
  - setDefaultWorker
```
@Nonnull
public Router setDefaultWorker(@Nonnull
                                        Executor worker)
```
    Description copied from interface: Router
    
    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 Router.getWorker() returns the default thread pool, unless you explicitly set one.
    
    Specified by:
    
    setDefaultWorker in interface Router
    
    Parameters:
    
    worker - Default worker thread pool.
    
    Returns:
    
    This router.
  - decorator
```
@Nonnull
public Router decorator(@Nonnull
                                 Route.Decorator decorator)
```
    Description copied from interface: Router
    
    Add a route decorator to the route pipeline.
    
    Specified by:
    
    decorator in interface Router
    
    Parameters:
    
    decorator - Decorator.
    
    Returns:
    
    This router.
  - after
```
@Nonnull
public Router after(@Nonnull
                             Route.After after)
```
    Description copied from interface: Router
    
    Add an after route decorator to the route pipeline.
    
    Specified by:
    
    after in interface Router
    
    Parameters:
    
    after - After decorator.
    
    Returns:
    
    This router.
  - before
```
@Nonnull
public Router before(@Nonnull
                              Route.Before before)
```
    Description copied from interface: Router
    
    Add a before route decorator to the route pipeline.
    
    Specified by:
    
    before in interface Router
    
    Parameters:
    
    before - Before decorator.
    
    Returns:
    
    This router.
  - error
```
@Nonnull
public Router error(@Nonnull
                             ErrorHandler handler)
```
    Description copied from interface: Router
    
    Add a custom error handler.
    
    Specified by:
    
    error in interface Router
    
    Parameters:
    
    handler - Error handler.
    
    Returns:
    
    This router.
  - dispatch
```
@Nonnull
public Router dispatch(@Nonnull
                                Runnable body)
```
    Description copied from interface: Router
    
    Dispatch route pipeline to the Router.getWorker() worker thread pool. After dispatch application code is allowed to do blocking calls.
    
    Specified by:
    
    dispatch in interface Router
    
    Parameters:
    
    body - Dispatch body.
    
    Returns:
    
    This router.
  - dispatch
```
@Nonnull
public Router dispatch(@Nonnull
                                Executor executor,
                                @Nonnull
                                Runnable action)
```
    Description copied from interface: Router
    
    Dispatch route pipeline to the given executor. After dispatch application code is allowed to do blocking calls.
    
    Specified by:
    
    dispatch in interface Router
    
    Parameters:
    
    executor - Executor. ExecutorService instances automatically shutdown at application exit.
    
    action - Dispatch body.
    
    Returns:
    
    This router.
  - routes
```
@Nonnull
public RouteSet routes(@Nonnull
                                Runnable action)
```
    Description copied from interface: Router
    
    Group one or more routes. Useful for applying cross cutting concerns to the enclosed routes.
    
    Specified by:
    
    routes in interface Router
    
    Parameters:
    
    action - Route body.
    
    Returns:
    
    All routes created.
  - path
```
@Nonnull
public RouteSet path(@Nonnull
                              String pattern,
                              @Nonnull
                              Runnable action)
```
    Description copied from interface: Router
    
    Group one or more routes under a common path prefix. Useful for applying cross cutting concerns to the enclosed routes.
    
    Specified by:
    
    path in interface Router
    
    Parameters:
    
    pattern - Path pattern.
    
    action - Route body.
    
    Returns:
    
    All routes created.
  - getSessionStore
```
@Nonnull
public SessionStore getSessionStore()
```
    Description copied from interface: Router
    
    Session store. Default use a cookie ID with a memory storage. See SessionStore.memory().
    
    Specified by:
    
    getSessionStore in interface Router
    
    Returns:
    
    Session store.
  - setSessionStore
```
@Nonnull
public Router setSessionStore(SessionStore sessionStore)
```
    Description copied from interface: Router
    
    Set session store.
    
    Specified by:
    
    setSessionStore in interface Router
    
    Parameters:
    
    sessionStore - Session store.
    
    Returns:
    
    This router.
  - converter
```
@Nonnull
public Router converter(ValueConverter converter)
```
    Description copied from interface: Router
    
    Add a custom string value converter.
    
    Specified by:
    
    converter in interface Router
    
    Parameters:
    
    converter - Custom value converter.
    
    Returns:
    
    This router.
  - converter
```
@Nonnull
public Router converter(@Nonnull
                                 BeanConverter converter)
```
    Description copied from interface: Router
    
    Add a custom bean value converter.
    
    Specified by:
    
    converter in interface Router
    
    Parameters:
    
    converter - Custom value converter.
    
    Returns:
    
    This router.
  - getConverters
```
@Nonnull
public List<ValueConverter> getConverters()
```
    Description copied from interface: Router
    
    Get all simple/string value converters.
    
    Specified by:
    
    getConverters in interface Router
    
    Returns:
    
    All simple/string value converters.
  - getBeanConverters
```
@Nonnull
public List<BeanConverter> getBeanConverters()
```
    Description copied from interface: Router
    
    Get all complex/bean value converters.
    
    Specified by:
    
    getBeanConverters in interface Router
    
    Returns:
    
    All complex/bean value converters.
  - ws
```
@Nonnull
public Route ws(@Nonnull
                         String pattern,
                         @Nonnull
                         WebSocket.Initializer handler)
```
    Description copied from interface: Router
    
    Add a websocket handler.
    
    Specified by:
    
    ws in interface Router
    
    Parameters:
    
    pattern - WebSocket path pattern.
    
    handler - WebSocket handler.
    
    Returns:
    
    A new route.
  - sse
```
@Nonnull
public Route sse(@Nonnull
                          String pattern,
                          @Nonnull
                          ServerSentEmitter.Handler handler)
```
    Description copied from interface: Router
    
    Add a server-sent event handler.
    
    Specified by:
    
    sse in interface Router
    
    Parameters:
    
    pattern - Path pattern.
    
    handler - Handler.
    
    Returns:
    
    A new route.
  - route
```
public Route route(@Nonnull
                   String method,
                   @Nonnull
                   String pattern,
                   @Nonnull
                   Route.Handler handler)
```
    Description copied from interface: Router
    
    Add a route.
    
    Specified by:
    
    route in interface Router
    
    Parameters:
    
    method - HTTP method.
    
    pattern - Path pattern.
    
    handler - Application code.
    
    Returns:
    
    A route.
  - start
```
@Nonnull
public Router start(@Nonnull
                             Jooby app)
```
  - getLog
```
public org.slf4j.Logger getLog()
```
    Description copied from interface: Router
    
    Application logger.
    
    Specified by:
    
    getLog in interface Router
    
    Returns:
    
    Application logger.
  - executor
```
@Nonnull
public Router executor(@Nonnull
                                String name,
                                @Nonnull
                                Executor executor)
```
    Description copied from interface: Router
    
    Put an executor into the application registry.
    
    Specified by:
    
    executor in interface Router
    
    Parameters:
    
    name - Executor's name.
    
    executor - Executor.
    
    Returns:
    
    This router.
  - destroy
```
public void destroy()
```
  - getErrorHandler
```
@Nonnull
public ErrorHandler getErrorHandler()
```
    Description copied from interface: Router
    
    Get the error handler.
    
    Specified by:
    
    getErrorHandler in interface Router
    
    Returns:
    
    An error handler.
  - match
```
@Nonnull
public Router.Match match(@Nonnull
                                   Context ctx)
```
    Description copied from interface: Router
    
    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.
    
    Specified by:
    
    match in interface Router
    
    Parameters:
    
    ctx - Web Context.
    
    Returns:
    
    A route match result.
  - match
```
public boolean match(@Nonnull
                     String pattern,
                     @Nonnull
                     String path)
```
    Description copied from interface: Router
    
    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.
    
    Specified by:
    
    match in interface Router
    
    Parameters:
    
    pattern - Method to match.
    
    path - Path to match.
    
    Returns:
    
    A route match result.
  - errorCode
```
@Nonnull
public Router errorCode(@Nonnull
                                 Class<? extends Throwable> type,
                                 @Nonnull
                                 StatusCode statusCode)
```
    Description copied from interface: Router
    
    Map an exception type to a status code.
    
    Specified by:
    
    errorCode in interface Router
    
    Parameters:
    
    type - Exception type.
    
    statusCode - Status code.
    
    Returns:
    
    This router.
  - errorCode
```
@Nonnull
public StatusCode errorCode(@Nonnull
                                     Throwable x)
```
    Description copied from interface: Router
    
    Computes the status code for the given exception.
    
    Specified by:
    
    errorCode in interface Router
    
    Parameters:
    
    x - Exception.
    
    Returns:
    
    Status code.
  - responseHandler
```
@Nonnull
public Router responseHandler(ResponseHandler handler)
```
    Description copied from interface: Router
    
    Add a response handler factory.
    
    Specified by:
    
    responseHandler in interface Router
    
    Parameters:
    
    handler - Response handler factory.
    
    Returns:
    
    This router.
  - getServices
```
@Nonnull
public ServiceRegistry getServices()
```
    Description copied from interface: Router
    
    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.
    
    Specified by:
    
    getServices in interface Router
    
    Returns:
    
    Service registry.
  - require
```
@Nonnull
public <T> T require(@Nonnull
                              Class<T> type,
                              @Nonnull
                              String name)
                       throws RegistryException
```
    Description copied from interface: Registry
    
    Provides an instance of the given type where name matches it.
    
    Specified by:
    
    require in interface Registry
    
    Type Parameters:
    
    T - Object type.
    
    Parameters:
    
    type - Object type.
    
    name - Object name.
    
    Returns:
    
    Instance of this type.
    
    Throws:
    
    RegistryException - If there was a runtime failure while providing an instance.
  - require
```
@Nonnull
public <T> T require(@Nonnull
                              Class<T> type)
                       throws RegistryException
```
    Description copied from interface: Registry
    
    Provides an instance of the given type.
    
    Specified by:
    
    require in interface Registry
    
    Type Parameters:
    
    T - Object type.
    
    Parameters:
    
    type - Object type.
    
    Returns:
    
    Instance of this type.
    
    Throws:
    
    RegistryException - If there was a runtime failure while providing an instance.
  - require
```
@Nonnull
public <T> T require(@Nonnull
                              ServiceKey<T> key)
                       throws RegistryException
```
    Description copied from interface: Registry
    
    Provides an instance of the given type.
    
    Specified by:
    
    require in interface Registry
    
    Type Parameters:
    
    T - Object type.
    
    Parameters:
    
    key - Object key.
    
    Returns:
    
    Instance of this type.
    
    Throws:
    
    RegistryException - If there was a runtime failure while providing an instance.
  - setFlashCookie
```
@Nonnull
public Router setFlashCookie(@Nonnull
                                      String name)
```
    Description copied from interface: Router
    
    Set flash cookie name.
    
    Specified by:
    
    setFlashCookie in interface Router
    
    Parameters:
    
    name - Flash cookie name.
    
    Returns:
    
    This router.
  - getFlashCookie
```
@Nonnull
public Cookie getFlashCookie()
```
    Description copied from interface: Router
    
    Template for the flash cookie. Default name is: jooby.flash.
    
    Specified by:
    
    getFlashCookie in interface Router
    
    Returns:
    
    Template for the flash cookie.
  - setFlashCookie
```
@Nonnull
public Router setFlashCookie(@Nonnull
                                      Cookie flashCookie)
```
    Description copied from interface: Router
    
    Sets a cookie used as a template to generate the flash cookie, allowing to customize the cookie name and other cookie parameters.
    
    Specified by:
    
    setFlashCookie in interface Router
    
    Parameters:
    
    flashCookie - The cookie template.
    
    Returns:
    
    This router.
  - getServerOptions
```
@Nonnull
public ServerOptions getServerOptions()
```
    Description copied from interface: Router
    
    Available server options.
    
    Specified by:
    
    getServerOptions in interface Router
    
    Returns:
    
    Server options.
  - setHiddenMethod
```
@Nonnull
public Router setHiddenMethod(@Nonnull
                                       String parameterName)
```
    Description copied from interface: Router
    
    Provides a way to override the current HTTP method. Request must be: - POST Form/multipart request For alternative strategy use the Router.setHiddenMethod(Function) method.
    
    Specified by:
    
    setHiddenMethod in interface Router
    
    Parameters:
    
    parameterName - Form field name.
    
    Returns:
    
    This router.
  - setHiddenMethod
```
@Nonnull
public Router setHiddenMethod(@Nonnull
                                       Function<Context,Optional<String>> provider)
```
    Description copied from interface: Router
    
    Provides a way to override the current HTTP method using lookup strategy.
    
    Specified by:
    
    setHiddenMethod in interface Router
    
    Parameters:
    
    provider - Lookup strategy.
    
    Returns:
    
    This router.
  - setCurrentUser
```
@Nonnull
public Router setCurrentUser(@Nonnull
                                      Function<Context,Object> provider)
```
    Description copied from interface: Router
    
    Provides a way to set the current user from a Context. Current user can be retrieve it using Context.getUser().
    
    Specified by:
    
    setCurrentUser in interface Router
    
    Parameters:
    
    provider - User provider/factory.
    
    Returns:
    
    This router.
  - setContextAsService
```
@Nonnull
public Router setContextAsService(boolean contextAsService)
```
    Description copied from interface: Router
    
    If enabled, allows to retrieve the Context object associated with the current request via the service registry while the request is being processed.
    
    Specified by:
    
    setContextAsService in interface Router
    
    Parameters:
    
    contextAsService - whether to enable or disable this feature
    
    Returns:
    
    This router.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RouterImpl

Nested Class Summary

Nested classes/interfaces inherited from interface io.jooby.Router

Field Summary

Fields inherited from interface io.jooby.Router

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.jooby.Router

Constructor Detail

RouterImpl

Method Detail

getConfig

getEnvironment

getLocales

getAttributes

getRouterOptions

setRouterOptions

setContextPath

getTmpdir

getContextPath

getRoutes

isTrustProxy

setTrustProxy

domain

domain

mount

mount

mount

mount

mvc

mvc

mvc

encoder

encoder

decoder

getWorker

setWorker

setDefaultWorker

decorator

after

before

error

dispatch

dispatch

routes

path

getSessionStore

setSessionStore

converter

converter

getConverters

getBeanConverters

ws

sse

route

start

getLog

executor

destroy

getErrorHandler

match

match

errorCode

errorCode

responseHandler

getServices

require

require

require

setFlashCookie

getFlashCookie

setFlashCookie

getServerOptions

setHiddenMethod

setHiddenMethod

setCurrentUser

setContextAsService

toString