org.opennms.core.config.api

Class ConfigReloadContainer<V>

java.lang.Object

org.opennms.core.config.api.ConfigReloadContainer<V>

Type Parameters:

V - type of configuration bean

All Implemented Interfaces:

ReloadingContainer<V>, RegistrationListener<ConfigurationProvider>

public class ConfigReloadContainer<V>
extends Object
implements ReloadingContainer<V>, RegistrationListener<ConfigurationProvider>

A container for managing configuation that sources the configuration from one or more ConfigurationProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigReloadContainer.Builder<V>

Method Summary

Modifier and Type	Method and Description
Long	getLastUpdate() Retrieve the time at which the object was last updated.
V	getObject() Retrieve the object held by the container.
void	providerRegistered(Registration registration, ConfigurationProvider provider) providerRegistered
void	providerUnregistered(Registration registration, ConfigurationProvider provider) providerUnregistered
void	reload() Immediately reload the object.
void	setReloadCheckInterval(Long reloadCheckInterval) Set the frequency at which the object should be checked for updates.

Methods inherited from class java.lang.Object

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

Method Detail

getObject

public V getObject()

Description copied from interface: ReloadingContainer

Retrieve the object held by the container. May also trigger a reload if the check interval has passed.

Specified by:

getObject in interface ReloadingContainer<V>

Returns:

the object

reload

public void reload()

Description copied from interface: ReloadingContainer

Immediately reload the object. The next call to ReloadingContainer.getObject() will return the updated object.

Specified by:

reload in interface ReloadingContainer<V>

setReloadCheckInterval

public void setReloadCheckInterval(Long reloadCheckInterval)

Description copied from interface: ReloadingContainer

Set the frequency at which the object should be checked for updates. The check is performed when calls to ReloadingContainer.getObject() are made once the interval has passed.

Specified by:

setReloadCheckInterval in interface ReloadingContainer<V>

Parameters:

reloadCheckInterval - interval in ms, if null the default value will be used, if <= 0 reload checks will be disabled

getLastUpdate

public Long getLastUpdate()

Description copied from interface: ReloadingContainer

Retrieve the time at which the object was last updated.

Specified by:

getLastUpdate in interface ReloadingContainer<V>

Returns:

timestamp in ms

providerRegistered

public void providerRegistered(Registration registration,
                               ConfigurationProvider provider)

Description copied from interface: RegistrationListener

providerRegistered

Specified by:

providerRegistered in interface RegistrationListener<ConfigurationProvider>

Parameters:

registration - a Registration object.

provider - a T object.

providerUnregistered

public void providerUnregistered(Registration registration,
                                 ConfigurationProvider provider)

Description copied from interface: RegistrationListener

providerUnregistered

Specified by:

providerUnregistered in interface RegistrationListener<ConfigurationProvider>

Parameters:

registration - a Registration object.

provider - a T object.