Package org.opennms.core.config.api

Interface ConfigurationProvider

All Known Implementing Classes:

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

public interface ConfigurationProvider

This interface allows extensions to provide configuration objects of a given type. See ConfigReloadContainer

Author:

jwhite

Method Summary

Modifier and Type	Method	Description
void	deregisteredFromConfigReloadContainer()	Notifies this configuration provider that it was unregistered from the ConfigReloadContainer.
long	getLastUpdate()
java.lang.Object	getObject()	Retrieve the actual configuration bean.
java.lang.Class<?>	getType()	Retrieve a class reference to the type of object returned by getObject().
void	registeredToConfigReloadContainer()	Notifies this configuration provider that it was registered with the ConfigReloadContainer.

Method Detail

getType

java.lang.Class<?> getType()

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

Returns:

the type of object returned by getObject()

getObject

java.lang.Object getObject()

Retrieve the actual configuration bean.

Returns:

the configuration bean, must be non-null

getLastUpdate

long getLastUpdate()

Returns:

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

registeredToConfigReloadContainer

void registeredToConfigReloadContainer()

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

deregisteredFromConfigReloadContainer

void deregisteredFromConfigReloadContainer()

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