All Implemented Interfaces:: Registry, Router

public class Jooby
extends Object
implements Router, Registry

Welcome to Jooby!

Hello World!



 public class App extends Jooby {

   {
     get("/", ctx -> "Hello World!");
   }

   public static void main(String[] args) {
     runApp(args, App::new);
   }
 }

Constructors
Constructor and Description
`Jooby()` Creates a new Jooby instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Jooby`	`after(Route.After after)` Add an after route decorator to the route pipeline.
`<T> T`	`attribute(String key)` Get an attribute by his key.
`Jooby`	`attribute(String key, Object value)` Set an application attribute.
`Jooby`	`before(Route.Before before)` Add a before route decorator to the route pipeline.
`Jooby`	`converter(BeanConverter converter)` Add a custom bean value converter.
`Jooby`	`converter(ValueConverter converter)` Add a custom string value converter.
`static Jooby`	`createApp(String[] args, ExecutionMode executionMode, Class<? extends Jooby> applicationType)` Setup default environment, logging (logback or log4j2) and run application.
`static Jooby`	`createApp(String[] args, ExecutionMode executionMode, Supplier<Jooby> provider)` Setup default environment, logging (logback or log4j2) and run application.
`Jooby`	`decoder(MediaType contentType, MessageDecoder decoder)` Register a decoder for the given content type.
`Jooby`	`decorator(Route.Decorator decorator)` Add a route decorator to the route pipeline.
`Jooby`	`dispatch(Executor executor, Runnable action)` Dispatch route pipeline to the given executor.
`Jooby`	`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.
`Jooby`	`encoder(MediaType contentType, MessageEncoder encoder)` Register a route response encoder.
`Jooby`	`encoder(MessageEncoder encoder)` Register a route response encoder.
`Jooby`	`error(ErrorHandler handler)` Add a custom error handler.
`Jooby`	`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.
`Jooby`	`executor(String name, Executor executor)` Put an executor into the application registry.
`Map<String,Object>`	`getAttributes()` Mutable map of application attributes.
`String`	`getBasePackage()` Get base application package.
`List<BeanConverter>`	`getBeanConverters()` Get all complex/bean value converters.
`ClassLoader`	`getClassLoader()` Application class loader.
`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.
`ExecutionMode`	`getExecutionMode()` Application execution mode.
`String`	`getFlashCookie()` Name of the flash cookie.
`org.slf4j.Logger`	`getLog()` Application logger.
`String`	`getName()` Get application's name.
`Router`	`getRouter()` The underlying router.
`Set<RouterOption>`	`getRouterOptions()` Router options.
`List<Route>`	`getRoutes()` Returns all routes.
`ServerOptions`	`getServerOptions()` Server options or `null`.
`ServiceRegistry`	`getServices()` Application service registry.
`SessionStore`	`getSessionStore()` Session store.
`Path`	`getTmpdir()` Application temporary directory.
`String`	`getVersion()` Get application version (description/debugging purpose only).
`Executor`	`getWorker()` Returns the worker thread pool.
`Jooby`	`install(Extension extension)` Install extension module.
`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.
`Jooby`	`mvc(Class router)` Import all route method from the given controller class.
`<T> Jooby`	`mvc(Class<T> router, javax.inject.Provider<T> provider)` Import all route method from the given controller class.
`Jooby`	`mvc(Object router)` Import all route methods from given controller instance.
`Jooby`	`onStarted(SneakyThrows.Runnable body)` Event is fire once all components has been initialized, for example router and web-server are up and running, extension installed, etc...
`Jooby`	`onStarting(SneakyThrows.Runnable body)` Event fired before starting router and web-server.
`Jooby`	`onStop(AutoCloseable body)` Stop event is fire at application shutdown time.
`RouteSet`	`path(String pattern, Runnable action)` Group one or more routes under a common path prefix.
`Jooby`	`ready(Server server)` Callback method that indicates application was successfully started it and listening for connections.
`Jooby`	`registry(Registry registry)` Set application registry.
`<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.
`Jooby`	`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.
`static void`	`runApp(String[] args, Class<? extends Jooby> applicationType)` Setup default environment, logging (logback or log4j2) and run application.
`static void`	`runApp(String[] args, Consumer<Jooby> consumer)` Setup default environment, logging (logback or log4j2) and run application.
`static void`	`runApp(String[] args, ExecutionMode executionMode, Class<? extends Jooby> applicationType)` Setup default environment, logging (logback or log4j2) and run application.
`static void`	`runApp(String[] args, ExecutionMode executionMode, Consumer<Jooby> consumer)` Setup default environment, logging (logback or log4j2) and run application.
`static void`	`runApp(String[] args, ExecutionMode executionMode, Supplier<Jooby> provider)` Setup default environment, logging (logback or log4j2) and run application.
`static void`	`runApp(String[] args, Supplier<Jooby> provider)` Setup default environment, logging (logback or log4j2) and run application.
`Jooby`	`setContextPath(String basePath)` Set application context path.
`Jooby`	`setDefaultWorker(Executor worker)` Set the default worker thread pool.
`Jooby`	`setEnvironment(Environment environment)` Set application environment.
`Environment`	`setEnvironmentOptions(EnvironmentOptions options)` Set environment options and initialize/overrides the environment.
`Jooby`	`setExecutionMode(ExecutionMode mode)` Set application execution mode.
`Jooby`	`setFlashCookie(String name)` Set flash cookie name.
`Jooby`	`setHiddenMethod(Function<Context,Optional<String>> provider)` Provides a way to override the current HTTP method using lookup strategy.
`Jooby`	`setHiddenMethod(String parameterName)` Provides a way to override the current HTTP method.
`Jooby`	`setLateInit(boolean lateInit)` Force all module to be initialized lazily at application startup time (not at creation/instantiation time).
`Jooby`	`setName(String name)` Set application name.
`Jooby`	`setRouterOptions(RouterOption... options)` Set router options.
`Jooby`	`setServerOptions(ServerOptions serverOptions)` Set server options.
`Jooby`	`setSessionStore(SessionStore store)` Set session store.
`Jooby`	`setTmpdir(Path tmpdir)` Set application temporary directory.
`Jooby`	`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).
`Jooby`	`setVersion(String version)` Set application version.
`Jooby`	`setWorker(Executor worker)` Set a worker thread pool.
`Route`	`sse(String pattern, ServerSentEmitter.Handler handler)` Add a server-sent event handler.
`Server`	`start()` Start application, find a web server, deploy application, start router, extension modules, etc..
`Jooby`	`start(Server server)` Call back method that indicates application was deploy it in the given server.
`Jooby`	`stop()` Stop application, fire the stop event to cleanup resources.
`String`	`toString()`
`Jooby`	`use(Predicate<Context> predicate, Router subrouter)` Import routes from given router.
`RouteSet`	`use(Predicate<Context> predicate, Runnable body)` Import routes from given action.
`Jooby`	`use(Router router)` Import all routes from the given router.
`Jooby`	`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 class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Constructor Detail
  - Jooby
```
public Jooby()
```
    Creates a new Jooby instance.
- Method Detail
  - getServerOptions
```
@Nullable
public ServerOptions getServerOptions()
```
    Server options or null.
    
    Specified by:
    
    getServerOptions in interface Router
    
    Returns:
    
    Server options or null.
  - setServerOptions
```
@Nonnull
public Jooby setServerOptions(@Nonnull
                                       ServerOptions serverOptions)
```
    Set server options.
    
    Parameters:
    
    serverOptions - Server options.
    
    Returns:
    
    This application.
  - 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 Jooby 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.
  - getEnvironment
```
@Nonnull
public Environment getEnvironment()
```
    Application environment. If none was set, environment is initialized using Environment.loadEnvironment(EnvironmentOptions).
    
    Returns:
    
    Application environment.
  - getClassLoader
```
@Nonnull
public ClassLoader getClassLoader()
```
    Application class loader.
    
    Returns:
    
    Application class loader.
  - getConfig
```
@Nonnull
public com.typesafe.config.Config getConfig()
```
    Application configuration. It is a shortcut for Environment.getConfig().
    
    Specified by:
    
    getConfig in interface Router
    
    Returns:
    
    Application config.
  - setEnvironment
```
@Nonnull
public Jooby setEnvironment(@Nonnull
                                     Environment environment)
```
    Set application environment.
    
    Parameters:
    
    environment - Application environment.
    
    Returns:
    
    This application.
  - setEnvironmentOptions
```
@Nonnull
public Environment setEnvironmentOptions(@Nonnull
                                                  EnvironmentOptions options)
```
    Set environment options and initialize/overrides the environment.
    
    Parameters:
    
    options - Environment options.
    
    Returns:
    
    New environment.
  - onStarting
```
@Nonnull
public Jooby onStarting(@Nonnull
                                 SneakyThrows.Runnable body)
```
    Event fired before starting router and web-server. Non-lateinit extension are installed at this stage.
    
    Parameters:
    
    body - Start body.
    
    Returns:
    
    This application.
  - onStarted
```
@Nonnull
public Jooby onStarted(@Nonnull
                                SneakyThrows.Runnable body)
```
    Event is fire once all components has been initialized, for example router and web-server are up and running, extension installed, etc...
    
    Parameters:
    
    body - Start body.
    
    Returns:
    
    This application.
  - onStop
```
@Nonnull
public Jooby onStop(@Nonnull
                             AutoCloseable body)
```
    Stop event is fire at application shutdown time. Useful to execute cleanup task, free resources, etc...
    
    Parameters:
    
    body - Stop body.
    
    Returns:
    
    This application.
  - setContextPath
```
@Nonnull
public Jooby 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.
  - 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).
  - use
```
@Nonnull
public Jooby use(@Nonnull
                          Router router)
```
    Description copied from interface: Router
    
    Import all routes from the given router.
    
    Specified by:
    
    use in interface Router
    
    Parameters:
    
    router - Router to import.
    
    Returns:
    
    This router.
  - getRouter
```
@Nonnull
public Router getRouter()
```
    The underlying router.
    
    Returns:
    
    The underlying router.
  - 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 Jooby 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 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).
    Specified by:
    
    domain in interface Router
    
    Parameters:
    
    domain - Predicate
    
    subrouter - Subrouter.
    
    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.
  - use
```
@Nonnull
public RouteSet use(@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:
```
 {
   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 Router.setTrustProxy(boolean).
    Specified by:
    
    use in interface Router
    
    Parameters:
    
    predicate - Context predicate.
    
    body - Route action.
    
    Returns:
    
    This router.
  - use
```
@Nonnull
public Jooby use(@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).
    Specified by:
    
    use in interface Router
    
    Parameters:
    
    predicate - Context predicate.
    
    subrouter - Router to import.
    
    Returns:
    
    This router.
  - use
```
@Nonnull
public Jooby use(@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.
    
    Specified by:
    
    use in interface Router
    
    Parameters:
    
    path - Prefix path.
    
    router - Router to import.
    
    Returns:
    
    This router.
  - mvc
```
@Nonnull
public Jooby 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 Jooby 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 require(Class).
    
    Specified by:
    
    mvc in interface Router
    
    Parameters:
    
    router - Controller class.
    
    Returns:
    
    This router.
  - mvc
```
@Nonnull
public <T> Jooby 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.
  - 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.
  - getRoutes
```
@Nonnull
public List<Route> getRoutes()
```
    Description copied from interface: Router
    
    Returns all routes.
    
    Specified by:
    
    getRoutes in interface Router
    
    Returns:
    
    All routes.
  - error
```
@Nonnull
public Jooby 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.
  - decorator
```
@Nonnull
public Jooby 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.
  - before
```
@Nonnull
public Jooby 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.
  - after
```
@Nonnull
public Jooby 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.
  - encoder
```
@Nonnull
public Jooby 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.
  - decoder
```
@Nonnull
public Jooby 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.
  - encoder
```
@Nonnull
public Jooby 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.
  - install
```
@Nonnull
public Jooby install(@Nonnull
                              Extension extension)
```
    Install extension module.
    
    Parameters:
    
    extension - Extension module.
    
    Returns:
    
    This application.
  - dispatch
```
@Nonnull
public Jooby 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 Jooby 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.
  - 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.
  - 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.
  - route
```
@Nonnull
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.
  - 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 Jooby 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 cause)
```
    Description copied from interface: Router
    
    Computes the status code for the given exception.
    
    Specified by:
    
    errorCode in interface Router
    
    Parameters:
    
    cause - Exception.
    
    Returns:
    
    Status code.
  - 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 Jooby setWorker(@Nonnull
                                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 Jooby 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.
  - getLog
```
@Nonnull
public org.slf4j.Logger getLog()
```
    Description copied from interface: Router
    
    Application logger.
    
    Specified by:
    
    getLog in interface Router
    
    Returns:
    
    Application logger.
  - responseHandler
```
@Nonnull
public Jooby 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.
  - getErrorHandler
```
@Nonnull
public ErrorHandler getErrorHandler()
```
    Description copied from interface: Router
    
    Get the error handler.
    
    Specified by:
    
    getErrorHandler in interface Router
    
    Returns:
    
    An error handler.
  - 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.
  - setTmpdir
```
@Nonnull
public Jooby setTmpdir(@Nonnull
                                Path tmpdir)
```
    Set application temporary directory.
    
    Parameters:
    
    tmpdir - Temp directory.
    
    Returns:
    
    This application.
  - getExecutionMode
```
@Nonnull
public ExecutionMode getExecutionMode()
```
    Application execution mode.
    
    Returns:
    
    Application execution mode.
  - setExecutionMode
```
@Nonnull
public Jooby setExecutionMode(@Nonnull
                                       ExecutionMode mode)
```
    Set application execution mode.
    
    Parameters:
    
    mode - Application execution mode.
    
    Returns:
    
    This application.
  - 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.
  - attribute
```
@Nonnull
public Jooby attribute(@Nonnull
                                String key,
                                @Nonnull
                                Object value)
```
    Description copied from interface: Router
    
    Set an application attribute.
    
    Specified by:
    
    attribute in interface Router
    
    Parameters:
    
    key - Attribute key.
    
    value - Attribute value.
    
    Returns:
    
    This router.
  - attribute
```
@Nonnull
public <T> T attribute(@Nonnull
                                String key)
```
    Description copied from interface: Router
    
    Get an attribute by his key. This is just an utility method around Router.getAttributes().
    
    Specified by:
    
    attribute in interface Router
    
    Type Parameters:
    
    T - Attribute type.
    
    Parameters:
    
    key - Attribute key.
    
    Returns:
    
    Attribute value.
  - require
```
@Nonnull
public <T> T require(@Nonnull
                              Class<T> type,
                              @Nonnull
                              String name)
```
    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.
  - require
```
@Nonnull
public <T> T require(@Nonnull
                              Class<T> type)
```
    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.
  - require
```
@Nonnull
public <T> T require(@Nonnull
                              ServiceKey<T> key)
```
    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.
  - registry
```
@Nonnull
public Jooby registry(@Nonnull
                               Registry registry)
```
    Set application registry.
    
    Parameters:
    
    registry - Application registry.
    
    Returns:
    
    This application.
  - getServices
```
@Nonnull
public ServiceRegistry getServices()
```
    Description copied from interface: Router
    
    Application service registry. Services are accessible via this registry or 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.
  - getBasePackage
```
@Nullable
public String getBasePackage()
```
    Get base application package. This is the package from where application was initialized or the package of a Jooby application sub-class.
    
    Returns:
    
    Base application package.
  - 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 Jooby setSessionStore(@Nonnull
                                      SessionStore store)
```
    Description copied from interface: Router
    
    Set session store.
    
    Specified by:
    
    setSessionStore in interface Router
    
    Parameters:
    
    store - Session store.
    
    Returns:
    
    This router.
  - executor
```
@Nonnull
public Jooby 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.
  - getFlashCookie
```
@Nonnull
public String getFlashCookie()
```
    Description copied from interface: Router
    
    Name of the flash cookie. Defaults is: jooby.flash.
    
    Specified by:
    
    getFlashCookie in interface Router
    
    Returns:
    
    Name of the flash cookie. Defaults is: jooby.flash.
  - setFlashCookie
```
@Nonnull
public Jooby 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.
  - converter
```
@Nonnull
public Jooby converter(@Nonnull
                                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 Jooby 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.
  - setHiddenMethod
```
@Nonnull
public Jooby 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.
  - setHiddenMethod
```
@Nonnull
public Jooby 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.
  - start
```
@Nonnull
public Server start()
```
    Start application, find a web server, deploy application, start router, extension modules, etc..
    
    Returns:
    
    Server.
  - start
```
@Nonnull
public Jooby start(@Nonnull
                            Server server)
```
    Call back method that indicates application was deploy it in the given server.
    
    Parameters:
    
    server - Server.
    
    Returns:
    
    This application.
  - ready
```
@Nonnull
public Jooby ready(@Nonnull
                            Server server)
```
    Callback method that indicates application was successfully started it and listening for connections.
    
    Parameters:
    
    server - Server.
    
    Returns:
    
    This application.
  - stop
```
@Nonnull
public Jooby stop()
```
    Stop application, fire the stop event to cleanup resources. This method is usually invoked by Server.stop() using a shutdown hook. The next example shows how to successfully stop the web server and application:
```
   Jooby app = new Jooby();

   Server server = app.start();

   ...

   server.stop();
 
```
    Returns:
    
    This application.
  - setLateInit
```
public Jooby setLateInit(boolean lateInit)
```
    Force all module to be initialized lazily at application startup time (not at creation/instantiation time). This option is present mostly for unit-test where you need to instantiated a Jooby instance without running extensions.
    
    Parameters:
    
    lateInit - True for late init.
    
    Returns:
    
    This application.
  - getName
```
@Nonnull
public String getName()
```
    Get application's name. If none set: - Try to get from Package.getImplementationTitle(). - Otherwise fallback to class name.
    
    Returns:
    
    Application's name.
  - setName
```
@Nonnull
public Jooby setName(@Nonnull
                              String name)
```
    Set application name.
    
    Parameters:
    
    name - Application's name.
    
    Returns:
    
    This application.
  - getVersion
```
@Nonnull
public String getVersion()
```
    Get application version (description/debugging purpose only). If none set: - Try to get it from Package.getImplementationVersion(). This attribute is present when application has been packaged (jar file). - Otherwise, fallback to 0.0.0.
    
    Returns:
    
    Application version.
  - setVersion
```
@Nonnull
public Jooby setVersion(@Nonnull
                                 String version)
```
    Set application version.
    
    Parameters:
    
    version - Application's version.
    
    Returns:
    
    This application.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - runApp
```
public static void runApp(@Nonnull
                          String[] args,
                          @Nonnull
                          Class<? extends Jooby> applicationType)
```
    Setup default environment, logging (logback or log4j2) and run application.
    
    Parameters:
    
    args - Application arguments.
    
    applicationType - Application type.
  - runApp
```
public static void runApp(@Nonnull
                          String[] args,
                          @Nonnull
                          ExecutionMode executionMode,
                          @Nonnull
                          Class<? extends Jooby> applicationType)
```
    Setup default environment, logging (logback or log4j2) and run application.
    
    Parameters:
    
    args - Application arguments.
    
    executionMode - Application execution mode.
    
    applicationType - Application type.
  - createApp
```
public static Jooby createApp(@Nonnull
                              String[] args,
                              @Nonnull
                              ExecutionMode executionMode,
                              @Nonnull
                              Class<? extends Jooby> applicationType)
```
    Setup default environment, logging (logback or log4j2) and run application.
    
    Parameters:
    
    args - Application arguments.
    
    executionMode - Application execution mode.
    
    applicationType - Application type.
    
    Returns:
    
    Application.
  - runApp
```
public static void runApp(@Nonnull
                          String[] args,
                          @Nonnull
                          Supplier<Jooby> provider)
```
    Setup default environment, logging (logback or log4j2) and run application.
    
    Parameters:
    
    args - Application arguments.
    
    provider - Application provider.
  - runApp
```
public static void runApp(@Nonnull
                          String[] args,
                          @Nonnull
                          Consumer<Jooby> consumer)
```
    Setup default environment, logging (logback or log4j2) and run application.
    
    Parameters:
    
    args - Application arguments.
    
    consumer - Application consumer.
  - runApp
```
public static void runApp(@Nonnull
                          String[] args,
                          @Nonnull
                          ExecutionMode executionMode,
                          @Nonnull
                          Consumer<Jooby> consumer)
```
    Setup default environment, logging (logback or log4j2) and run application.
    
    Parameters:
    
    args - Application arguments.
    
    executionMode - Application execution mode.
    
    consumer - Application consumer.
  - runApp
```
public static void runApp(@Nonnull
                          String[] args,
                          @Nonnull
                          ExecutionMode executionMode,
                          @Nonnull
                          Supplier<Jooby> provider)
```
    Setup default environment, logging (logback or log4j2) and run application.
    
    Parameters:
    
    args - Application arguments.
    
    executionMode - Application execution mode.
    
    provider - Application provider.
  - createApp
```
public static Jooby createApp(@Nonnull
                              String[] args,
                              @Nonnull
                              ExecutionMode executionMode,
                              @Nonnull
                              Supplier<Jooby> provider)
```
    Setup default environment, logging (logback or log4j2) and run application.
    
    Parameters:
    
    args - Application arguments.
    
    executionMode - Application execution mode.
    
    provider - Application provider.
    
    Returns:
    
    Application.

Class Jooby

Welcome to Jooby!

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

Jooby

Method Detail

getServerOptions

setServerOptions

getRouterOptions

setRouterOptions

getEnvironment

getClassLoader

getConfig

setEnvironment

setEnvironmentOptions

onStarting

onStarted

onStop

setContextPath

getContextPath

use

getRouter

isTrustProxy

setTrustProxy

domain

domain

use

use

use

mvc

mvc

mvc

ws

sse

getRoutes

error

decorator

before

after

encoder

decoder

encoder

install

dispatch

dispatch

path

routes

route

match

match

errorCode

errorCode

getWorker

setWorker

setDefaultWorker

getLog

responseHandler

getErrorHandler

getTmpdir

setTmpdir

getExecutionMode

setExecutionMode

getAttributes

attribute

attribute

require

require

require

registry

getServices

getBasePackage

getSessionStore

setSessionStore