org.jooby

Interface Jooby.Module

All Known Implementing Classes:

Akka, ApiTool, Assets, Auth, Aws, Banner, CaffeineCache, Camel, Cassandra, CommonsEmail, Consulby, Couchbase, Crash, Ebeanby, Eh, Elasticsearch, EventBusby, Exec, FileWatcher, FlashScope, Flywaydb, Frontend, Ftl, GuavaCache, Gzon, Hbm, Hbs, Hbv, Hcast, Jackson, Jade, Jdbc, Jdbi, Jdbi3, Jetty, Jongoby, jOOQ, org.jooby.internal.sitemap.JSitemap, LiveReload, Metrics, Micrometer, Mongodb, MongoRx, Monphia, Neo4j, Netty, Npm, Pac4j, Pebble, Quartz, QueryDSL, Reactor, Redis, RedisSentinel, Requery, Rockerby, Rx, RxJdbc, Scanner, ServerInitializer.ServletModule, Sitemap, SpyMemcached, Thl, Undertow, Whoops, XSS, XSS, Yarn, Yasson

Enclosing class:

Jooby

public static interface Jooby.Module

A module can publish or produces: routes, Parser, Renderer, and any other application specific service or contract of your choice.

It is similar to Module except for the callback method receives a Env, Config and Binder.

A module can provide his own set of properties through the config() method. By default, this method returns an empty config object.

For example:

   use(new M1());
   use(new M2());
   use(new M3());
 

Previous example had the following order (first-listed are higher priority):

• System properties
• application.conf
• M3 properties
• M2 properties
• M1 properties

A module can provide start/stop methods in order to start or close resources.

Since:

0.1.0

Author:

edgar

See Also:

Jooby.use(Jooby.Module)

Method Summary

Modifier and Type	Method and Description
default com.typesafe.config.Config	config()
void	configure(Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder) Configure and produces bindings for the underlying application.

Method Detail

config

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

Returns:

Produces a module config object (when need it). By default a module doesn't produce any configuration object.

configure

void configure(Env env,
               com.typesafe.config.Config conf,
               com.google.inject.Binder binder)
        throws Throwable

Configure and produces bindings for the underlying application. A module can optimize or customize a service by checking current the application env and/or the current application properties available from Config.

Parameters:

env - The current application's env. Not null.

conf - The current config object. Not null.

binder - A guice binder. Not null.

Throws:

Throwable - If something goes wrong.