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
<T> void	install(com.google.inject.Binder binder, java.lang.Class<? extends T> type, boolean lazy) Called to apply custom binding for installed feature.
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

install

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

Description copied from interface: BindingInstaller

Called to apply custom binding for installed feature. All found features installed as binder.install(type) by default, so implement it only if some custom binding required.

Specified by:

install in interface BindingInstaller

Type Parameters:

T - plugin type (used just to define strict hierarchy and simplify binding)

Parameters:

binder - guice binder

type - extension class

lazy - true if extension is annotated with @LazyBinding

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>