Package io.datarouter.storage.config

Class BaseStoragePlugin

java.lang.Object

com.google.inject.AbstractModule

io.datarouter.inject.guice.BaseGuiceModule

io.datarouter.inject.guice.BasePlugin

io.datarouter.storage.config.BaseStoragePlugin

All Implemented Interfaces:

com.google.inject.Module, io.datarouter.inject.guice.GuiceOptionalBinder

Direct Known Subclasses:

DatarouterStoragePlugin

public abstract class BaseStoragePlugin
extends io.datarouter.inject.guice.BasePlugin

Plugins are verbose wrappers around GuiceModules for easy installation of datarouter modules. They use a builder pattern to specify required and optional implementations of classes used by the module. Some modules have their own extensions of BasePlugin which allows more features to get configured easily. BasePlugin auto configures and binds cluster settings and dao registration.

Field Summary

Fields

Modifier and Type	Field	Description
final Map<PluginConfigKey<?>,List<Class<? extends PluginConfigValue<?>>>>	classList
final Map<PluginConfigKey<?>,Class<? extends PluginConfigValue<?>>>	classSingle
final Map<PluginConfigKey<?>,List<PluginConfigValue<?>>>	instanceList
final Map<PluginConfigKey<?>,PluginConfigValue<?>>	instanceSingle

Constructor Summary

Constructors

Constructor	Description
BaseStoragePlugin()

Method Summary

Modifier and Type	Method	Description
void	addPluginConfig(Map<PluginConfigKey<?>,List<Class<? extends PluginConfigValue<?>>>> map)
protected void	addPluginEntries(PluginConfigKey<?> key, Collection<Class<? extends PluginConfigValue<?>>> values)
protected void	addPluginEntries(Collection<PluginConfigValue<?>> values)
protected void	addPluginEntry(PluginConfigKey<?> key, Class<? extends PluginConfigValue<?>> value)
protected void	addPluginEntry(PluginConfigValue<?> value)
protected void	addSettingRoot(Class<? extends SettingRoot> settingRoot)
protected void	addStoragePlugin(BaseStoragePlugin storagePlugin)
protected void	addTestModule(com.google.inject.Module testModule)
DaosModuleBuilder	getDaosModuleBuilder()
List<BaseStoragePlugin>	getStoragePlugins()
List<com.google.inject.Module>	getTestModules()
protected void	setDaos(Class<? extends Dao>... daos)
protected void	setDaosModule(DaosModuleBuilder daosModule)

Methods inherited from class io.datarouter.inject.guice.BasePlugin

getAsDefaultBinderModule, getName

Methods inherited from class io.datarouter.inject.guice.BaseGuiceModule

bindUnsupported, getGuiceBinder

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.datarouter.inject.guice.GuiceOptionalBinder

bindActual, bindActualInstance, bindActualInstance, bindActualInstance, bindDefault, bindDefaultInstance, bindDefaultInstance, bindDefaultInstance, optionalBinder, optionalBinder, optionalBinder

Field Details

classSingle

public final Map<PluginConfigKey<?>,Class<? extends PluginConfigValue<?>>> classSingle

classList

public final Map<PluginConfigKey<?>,List<Class<? extends PluginConfigValue<?>>>> classList

instanceSingle

public final Map<PluginConfigKey<?>,PluginConfigValue<?>> instanceSingle

instanceList

public final Map<PluginConfigKey<?>,List<PluginConfigValue<?>>> instanceList

Constructor Details

BaseStoragePlugin

public BaseStoragePlugin()

Method Details

addSettingRoot

protected void addSettingRoot(Class<? extends SettingRoot> settingRoot)

setDaosModule

protected void setDaosModule(DaosModuleBuilder daosModule)

getDaosModuleBuilder

public DaosModuleBuilder getDaosModuleBuilder()

setDaos

protected void setDaos(Class<? extends Dao>... daos)

addStoragePlugin

protected void addStoragePlugin(BaseStoragePlugin storagePlugin)

getStoragePlugins

public List<BaseStoragePlugin> getStoragePlugins()

addTestModule

protected void addTestModule(com.google.inject.Module testModule)

getTestModules

public List<com.google.inject.Module> getTestModules()

addPluginConfig

public void addPluginConfig(Map<PluginConfigKey<?>,List<Class<? extends PluginConfigValue<?>>>> map)

addPluginEntries

protected void addPluginEntries(PluginConfigKey<?> key,
 Collection<Class<? extends PluginConfigValue<?>>> values)

addPluginEntries

protected void addPluginEntries(Collection<PluginConfigValue<?>> values)

addPluginEntry

protected void addPluginEntry(PluginConfigKey<?> key,
 Class<? extends PluginConfigValue<?>> value)

addPluginEntry

protected void addPluginEntry(PluginConfigValue<?> value)