ru.vyarus.dropwizard.guice

Class GuiceBundle.Builder<T extends io.dropwizard.Configuration>

java.lang.Object

ru.vyarus.dropwizard.guice.GuiceBundle.Builder<T>

Type Parameters:

T - configuration type

Enclosing class:

GuiceBundle<T extends io.dropwizard.Configuration>

public static class GuiceBundle.Builder<T extends io.dropwizard.Configuration>
extends java.lang.Object

Builder encapsulates bundle configuration options.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GuiceBundle<T>	build()
GuiceBundle<T>	build(com.google.inject.Stage stage)
GuiceBundle.Builder<T>	bundles(GuiceyBundle... bundles) Guicey bundles are mainly useful for extensions (to group installers and extensions installation without auto scan).
GuiceBundle.Builder<T>	configureFromDropwizardBundles(boolean enable) If enabled registered dropwizard bundles are checked if they implement GuiceyBundle and called to configure guice.
GuiceBundle.Builder<T>	disableInstallers(java.lang.Class<? extends FeatureInstaller>... installers)
GuiceBundle.Builder<T>	enableAutoConfig(java.lang.String... basePackages) Enables auto scan feature.
GuiceBundle.Builder<T>	extensions(java.lang.Class<?>... extensionClasses) Beans could be registered automatically when auto scan enabled, but if you don't want to use it, you can register beans manually.
GuiceBundle.Builder<T>	injectorFactory(InjectorFactory injectorFactory) Configures custom InjectorFactory.
GuiceBundle.Builder<T>	installers(java.lang.Class<? extends FeatureInstaller>... installers) Feature installers registered automatically when auto scan enabled, but if you don't want to use it, you can register installers manually (note: without auto scan default installers will not be registered).
GuiceBundle.Builder<T>	modules(com.google.inject.Module... modules) NOTE: if module implements *AwareModule interfaces, objects will be set just before configuration start.
GuiceBundle.Builder<T>	searchCommands(boolean searchCommands) NOTE: will not scan if auto scan not enabled (packages not configured).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

injectorFactory

public GuiceBundle.Builder<T> injectorFactory(InjectorFactory injectorFactory)

Configures custom InjectorFactory. Required by some guice extensions like governator.

Parameters:

injectorFactory - custom guice injector factory

Returns:

builder instance for chained calls

enableAutoConfig

public GuiceBundle.Builder<T> enableAutoConfig(java.lang.String... basePackages)

Enables auto scan feature. When enabled, all core installers are registered automatically.

Parameters:

basePackages - packages to scan extensions in

Returns:

builder instance for chained calls

modules

public GuiceBundle.Builder<T> modules(com.google.inject.Module... modules)

NOTE: if module implements *AwareModule interfaces, objects will be set just before configuration start.

Parameters:

modules - one or more juice modules

Returns:

builder instance for chained calls

See Also:

BootstrapAwareModule, ConfigurationAwareModule, EnvironmentAwareModule, DropwizardAwareModule

searchCommands

public GuiceBundle.Builder<T> searchCommands(boolean searchCommands)

NOTE: will not scan if auto scan not enabled (packages not configured).

Parameters:

searchCommands - true to enable class path scanning for commands, false to disable (default)

Returns:

builder instance for chained calls

disableInstallers

@SafeVarargs
public final GuiceBundle.Builder<T> disableInstallers(java.lang.Class<? extends FeatureInstaller>... installers)

Parameters:

installers - feature installer types to disable

Returns:

builder instance for chained calls

installers

@SafeVarargs
public final GuiceBundle.Builder<T> installers(java.lang.Class<? extends FeatureInstaller>... installers)

Feature installers registered automatically when auto scan enabled, but if you don't want to use it, you can register installers manually (note: without auto scan default installers will not be registered).

Also, could be used to add installers from packages not included in auto scanning.

Parameters:

installers - feature installer classes to register

Returns:

builder instance for chained calls

extensions

public GuiceBundle.Builder<T> extensions(java.lang.Class<?>... extensionClasses)

Beans could be registered automatically when auto scan enabled, but if you don't want to use it, you can register beans manually.

Guice injector will instantiate beans and registered installers will be used to recognize and properly register provided extension beans.

Also, could be used to add beans from packages not included in auto scanning.

NOTE: startup will fail if bean not recognized by installers.

NOTE: Don't register commands here: either enable auto scan, which will install commands automatically or register command directly to bootstrap object and dependencies will be injected to them after injector creation.

Parameters:

extensionClasses - extension bean classes to register

Returns:

builder instance for chained calls

bundles

public GuiceBundle.Builder<T> bundles(GuiceyBundle... bundles)

Guicey bundles are mainly useful for extensions (to group installers and extensions installation without auto scan). Its very like dropwizard bundles.

Its also possible to use dropwizard bundles as guicey bundles: bundle must implement GuiceyBundle and configureFromDropwizardBundles(boolean) must be enabled (disabled by default). This allows using dropwizard bundles as universal extension point.

Parameters:

bundles - guicey bundles

Returns:

builder instance for chained calls

configureFromDropwizardBundles

public GuiceBundle.Builder<T> configureFromDropwizardBundles(boolean enable)

If enabled registered dropwizard bundles are checked if they implement GuiceyBundle and called to configure guice. This allows using dropwizard bundles as universal extension point.

Disabled by default.

Parameters:

enable - true to enable configuration from dropwizard bundles

Returns:

builder instance for chained calls

build

public GuiceBundle<T> build(com.google.inject.Stage stage)

Parameters:

stage - stage to run injector with

Returns:

bundle instance

build

public GuiceBundle<T> build()

Returns:

bundle instance with implicit PRODUCTION stage