ru.vyarus.dropwizard.guice.module.installer.bundle

Class GuiceyBootstrap

java.lang.Object

ru.vyarus.dropwizard.guice.module.installer.bundle.GuiceyBootstrap

public class GuiceyBootstrap
extends java.lang.Object

Guicey initialization object. Provides almost the same configuration methods as GuiceBundle.Builder. Also, contains dropwizard bootstrap objects. May register pure dropwizard bundles.

In contrast to main builder, guicey bundle can't:

• Disable bundles (because at this stage bundles already partly processed)
• Use generic disable predicates (to not allow bundles disable, moreover it's tests-oriented feature)
• Change options (because some bundles may already apply configuration based on changed option value which will mean inconsistent state)
• Register listener, implementing GuiceyConfigurationHook (because it's too late - all hooks were processed)
• Register some special objects like custom injector factory or custom bundles lookup

Since:

01.08.2015

Constructor Summary

Constructors

Constructor and Description
GuiceyBootstrap(ConfigurationContext context, java.util.List<GuiceyBundle> iterationBundles)

Method Summary

Modifier and Type	Method and Description
io.dropwizard.Application	application() Application instance may be useful for complex (half manual) integrations where access for injector is required.
<T extends io.dropwizard.Configuration> io.dropwizard.setup.Bootstrap<T>	bootstrap() Note: application is already in run phase, so it's too late to configure dropwizard bootstrap object.
GuiceyBootstrap	bundles(GuiceyBundle... bundles) Register other guicey bundles for installation.
GuiceyBootstrap	disableExtensions(java.lang.Class<?>... extensions)
GuiceyBootstrap	disableInstallers(java.lang.Class<? extends FeatureInstaller>... installers)
GuiceyBootstrap	disableModules(java.lang.Class<? extends com.google.inject.Module>... modules) Disable both usual and overriding guice modules.
GuiceyBootstrap	dropwizardBundles(io.dropwizard.ConfiguredBundle... bundles) Shortcut for dropwizard bundles registration (instead of bootstrap().addBundle()), but with duplicates detection and tracking in diagnostic reporting.
GuiceyBootstrap	extensions(java.lang.Class<?>... extensionClasses) Bundle should not rely on auto-scan mechanism and so must declare all extensions manually (this better declares bundle content and speed ups startup).
GuiceyBootstrap	installers(java.lang.Class<? extends FeatureInstaller>... installers) If bundle provides new installers then they must be declared here.
GuiceyBootstrap	listen(GuiceyLifecycleListener... listeners) Guicey broadcast a lot of events in order to indicate lifecycle phases (GuiceyLifecycle).
GuiceyBootstrap	modules(com.google.inject.Module... modules) Register guice modules.
GuiceyBootstrap	modulesOverride(com.google.inject.Module... modules) Override modules (using guice Modules.override(Module...)).
<V,T extends java.lang.Enum & Option> V	option(T option) Read option value.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiceyBootstrap

public GuiceyBootstrap(ConfigurationContext context,
                       java.util.List<GuiceyBundle> iterationBundles)

Method Detail

bootstrap

public <T extends io.dropwizard.Configuration> io.dropwizard.setup.Bootstrap<T> bootstrap()

Note: application is already in run phase, so it's too late to configure dropwizard bootstrap object. Object provided just for consultation.

Type Parameters:

T - configuration type

Returns:

dropwizard bootstrap instance

application

public io.dropwizard.Application application()

Application instance may be useful for complex (half manual) integrations where access for injector is required. For example, manually registered Managed may access injector in it's start method by calling InjectorLookup.getInjector(Application).

NOTE: it will work in this example, because injector access will be after injector creation. Directly inside bundle initialization method injector could not be obtained as it's not exists yet.

Returns:

dropwizard application instance

option

public <V,T extends java.lang.Enum & Option> V option(T option)

Read option value. Options could be set only in application root GuiceBundle.Builder.option(Enum, Object). If value wasn't set there then default value will be returned. Null may return only if it was default value and no new value were assigned.

Option access is tracked as option usage (all tracked data is available through OptionsInfo).

Type Parameters:

V - option value type

T - helper type to define option

Parameters:

option - option enum

Returns:

assigned option value or default value

See Also:

more options info, options example, options definition

modules

public GuiceyBootstrap modules(com.google.inject.Module... modules)

Register guice modules.

Note that this registration appear under initialization phase and so neither configuration nor environment objects are not available yet. If you need them for module, then you can wrap it with DropwizardAwareModule or register modules in run phase (inside GuiceyBundle.run(GuiceyEnvironment)).

Parameters:

modules - one or more guice modules

Returns:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.modules(com.google.inject.Module...), DropwizardAwareModule

modulesOverride

public GuiceyBootstrap modulesOverride(com.google.inject.Module... modules)

Override modules (using guice Modules.override(Module...)).

Parameters:

modules - overriding modules

Returns:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.modulesOverride(Module...)

installers

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

If bundle provides new installers then they must be declared here. Optionally, core or other 3rd party installers may be declared also to indicate dependency (duplicate installers registrations will be removed).

Parameters:

installers - feature installer classes to register

Returns:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.installers(Class[])

extensions

public GuiceyBootstrap extensions(java.lang.Class<?>... extensionClasses)

Bundle should not rely on auto-scan mechanism and so must declare all extensions manually (this better declares bundle content and speed ups startup).

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:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.extensions(Class[])

bundles

public GuiceyBootstrap bundles(GuiceyBundle... bundles)

Register other guicey bundles for installation.

Equal instances of the same type will be considered as duplicate.

Parameters:

bundles - guicey bundles

Returns:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.bundles(GuiceyBundle...)

dropwizardBundles

public GuiceyBootstrap dropwizardBundles(io.dropwizard.ConfiguredBundle... bundles)

Shortcut for dropwizard bundles registration (instead of bootstrap().addBundle()), but with duplicates detection and tracking in diagnostic reporting. Dropwizard bundle is immediately initialized.

Parameters:

bundles - dropwizard bundles to register

Returns:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.dropwizardBundles(ConfiguredBundle...)

disableInstallers

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

Parameters:

installers - feature installer types to disable

Returns:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.disableInstallers(Class[])

disableExtensions

public final GuiceyBootstrap disableExtensions(java.lang.Class<?>... extensions)

Parameters:

extensions - extensions to disable (manually added, registered by bundles or with classpath scan)

Returns:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.disableExtensions(Class[])

disableModules

@SafeVarargs
public final GuiceyBootstrap disableModules(java.lang.Class<? extends com.google.inject.Module>... modules)

Disable both usual and overriding guice modules.

If bindings analysis is not disabled, could also disable inner (transitive) modules, but only inside normal modules.

Parameters:

modules - guice module types to disable

Returns:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.disableModules(Class[])

listen

public GuiceyBootstrap listen(GuiceyLifecycleListener... listeners)

Guicey broadcast a lot of events in order to indicate lifecycle phases (GuiceyLifecycle). Listener, registered in bundles could listen events from GuiceyLifecycle.BundlesInitialized.

Listener is not registered if equal listener was already registered (Set used as listeners storage), so if you need to be sure that only one instance of some listener will be used implement Object.equals(Object).

WARNING: don't register listeners implementing GuiceyConfigurationHook - such registrations will be rejected (it is too late - all hooks were already processed, but, as listener requires hooks support, assuming it can't work without proper configuration).

Parameters:

listeners - guicey lifecycle listeners

Returns:

bootstrap instance for chained calls

See Also:

GuiceBundle.Builder.listen(GuiceyLifecycleListener...)