ru.vyarus.dropwizard.guice.module.installer.feature.plugin

Class PluginInstaller

java.lang.Object

ru.vyarus.dropwizard.guice.module.installer.feature.plugin.PluginInstaller

All Implemented Interfaces:

FeatureInstaller<java.lang.Object>, BindingInstaller

public class PluginInstaller
extends java.lang.Object
implements FeatureInstaller<java.lang.Object>, BindingInstaller

Shortcut for guice multibindings mechanism. Register beans annotated with Plugin annotation into set multibinding by base class defined in annotation. Registered set may be later injected in code as Set<BaseType> plugins.

To use Map<String, BaseType> create new annotation, annotated with @Plugin. Use new annotation to define plugins. It's value attribute will be used as key (this way you can use different enums for different plugin types and not need to always write plugin interface.

Since:

08.10.2014

Constructor Summary

Constructors

Constructor and Description
PluginInstaller()

Method Summary

Modifier and Type	Method and Description
void	bindExtension(com.google.inject.Binder binder, java.lang.Class<?> type, boolean lazy) Called to apply custom binding for installed feature.
<T> void	checkBinding(com.google.inject.Binder binder, java.lang.Class<T> type, com.google.inject.Binding<T> manualBinding) Called for extensions, resolved from guice bindings (in user modules).
void	installBinding(com.google.inject.Binder binder, java.lang.Class<?> type) Called after execution of one of above methods.
boolean	matches(java.lang.Class<?> type) NOTE: consider using ru.vyarus.dropwizard.guice.module.installer.util.FeatureUtils to simplify checks (for example, types most likely must be checks to be not abstract).
void	report() Called to log registered endpoints in dropwizard log fashion.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginInstaller

public PluginInstaller()

Method Detail

matches

public boolean matches(java.lang.Class<?> type)

Description copied from interface: FeatureInstaller

NOTE: consider using ru.vyarus.dropwizard.guice.module.installer.util.FeatureUtils to simplify checks (for example, types most likely must be checks to be not abstract).

When type accepted by any extension it's registered in guice module.

Specified by:

matches in interface FeatureInstaller<java.lang.Object>

Parameters:

type - type to check

Returns:

true if extension recognized, false otherwise

bindExtension

public void bindExtension(com.google.inject.Binder binder,
                          java.lang.Class<?> type,
                          boolean lazy)

Description copied from interface: BindingInstaller

Called to apply custom binding for installed feature. By default, all found extensions are installed as binder.bind(type). This method will be called instead of default registration.

Called only for non binding extensions (extensions that are not already bound in guice module.

WARNING: may be called multiple times due to enabled bindings reporting! Be sure to produce correct logs.

Specified by:

bindExtension in interface BindingInstaller

Parameters:

binder - guice binder

type - extension class

lazy - true if extension is annotated with LazyBinding

checkBinding

public <T> void checkBinding(com.google.inject.Binder binder,
                             java.lang.Class<T> type,
                             com.google.inject.Binding<T> manualBinding)

Description copied from interface: BindingInstaller

Called for extensions, resolved from guice bindings (in user modules). May be used to validate binding or do some additional bindings with existing binding.

LazyBinding flag is not used here because guicey will automatically throw an error if existing binding is annotated as lazy binding (which don't makes any sense).

WARNING: may be called multiple times due to enabled bindings reporting! Be sure to produce correct logs.

Specified by:

checkBinding in interface BindingInstaller

Type Parameters:

T - extension type, used to connect extension class with binding

Parameters:

binder - guice binder

type - extension class

manualBinding - binding declaration from guice module

See Also:

for errors reporting

installBinding

public void installBinding(com.google.inject.Binder binder,
                           java.lang.Class<?> type)

Description copied from interface: BindingInstaller

Called after execution of one of above methods. May be useful to perform common actions for both cases or simply for reporting.

WARNING: may be called multiple times due to enabled bindings reporting! Be sure to produce correct logs.

Specified by:

installBinding in interface BindingInstaller

Parameters:

binder - guice binder

type - extension class

report

public void report()

Description copied from interface: FeatureInstaller

Called to log registered endpoints in dropwizard log fashion. It's important to naturally show all dynamically resolved classes to easily catch errors. Use Reporter to simplify reporting.

Method may do nothing if reporting not required

Specified by:

report in interface FeatureInstaller<java.lang.Object>