Package org.opennms.features.apilayer.config

Class ConfigExtensionManager<E,C>

java.lang.Object

org.opennms.features.apilayer.config.ConfigExtensionManager<E,C>

Type Parameters:

E - extension interface type

C - configuration bean type

All Implemented Interfaces:

ConfigurationProvider

Direct Known Subclasses:

EventConfExtensionManager, GraphPropertiesExtensionManager, ResourceTypesExtensionManager, SnmpCollectionExtensionManager, SyslogMatchExtensionManager, ThreshdConfigurationExtensionManager, ThresholdingConfigExtensionManager

public abstract class ConfigExtensionManager<E,C>
extends java.lang.Object
implements ConfigurationProvider

A ConfigurationProvider which is driven by API extensions.

Constructor Summary

Constructors

Constructor	Description
ConfigExtensionManager(java.lang.Class<C> clazz, C initialObject)

Method Summary

Modifier and Type	Method	Description
void	deregisteredFromConfigReloadContainer()	Notifies this configuration provider that it was unregistered from the ConfigReloadContainer.
protected abstract C	getConfigForExtensions(java.util.Set<E> extensions)
long	getLastUpdate()
C	getObject()	Retrieve the actual configuration bean.
java.lang.Class<?>	getType()	Retrieve a class reference to the type of object returned by ConfigurationProvider.getObject().
void	onBind(E extension, java.util.Map properties)
void	onUnbind(E extension, java.util.Map properties)
void	registeredToConfigReloadContainer()	Notifies this configuration provider that it was registered with the ConfigReloadContainer.
protected abstract void	triggerReload()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigExtensionManager

public ConfigExtensionManager(java.lang.Class<C> clazz,
                              C initialObject)

Method Detail

onBind

public void onBind(E extension,
                   java.util.Map properties)

onUnbind

public void onUnbind(E extension,
                     java.util.Map properties)

registeredToConfigReloadContainer

public void registeredToConfigReloadContainer()

Description copied from interface: ConfigurationProvider

Notifies this configuration provider that it was registered with the ConfigReloadContainer.

Specified by:

registeredToConfigReloadContainer in interface ConfigurationProvider

deregisteredFromConfigReloadContainer

public void deregisteredFromConfigReloadContainer()

Description copied from interface: ConfigurationProvider

Notifies this configuration provider that it was unregistered from the ConfigReloadContainer.

Specified by:

deregisteredFromConfigReloadContainer in interface ConfigurationProvider

getConfigForExtensions

protected abstract C getConfigForExtensions(java.util.Set<E> extensions)

triggerReload

protected abstract void triggerReload()

getType

public java.lang.Class<?> getType()

Description copied from interface: ConfigurationProvider

Retrieve a class reference to the type of object returned by ConfigurationProvider.getObject(). This is used instead of generics to be OSGi friendly.

Specified by:

getType in interface ConfigurationProvider

Returns:

the type of object returned by ConfigurationProvider.getObject()

getObject

public C getObject()

Description copied from interface: ConfigurationProvider

Retrieve the actual configuration bean.

Specified by:

getObject in interface ConfigurationProvider

Returns:

the configuration bean, must be non-null

getLastUpdate

public long getLastUpdate()

Specified by:

getLastUpdate in interface ConfigurationProvider

Returns:

the last time (in ms) at which the configuration bean was updated