public interface ConfigEventManagerSpi
ConfigEventManager
singleton.
Implementations of this interface must be registered with the current ServiceContext
,
by default this equals to registering it with ServiceLoader
. Add Priority
annotations for overriding (higher values override lower values).Modifier and Type | Method and Description |
---|---|
<T> void |
addListener(ConfigEventListener l)
Adds a listener for observing events.
|
<T extends ConfigEvent> |
addListener(ConfigEventListener l,
Class<T> eventType)
Adds a listener for observing events of a given type.
|
void |
enableChangeMonitor(boolean enable)
Start/stop the change monitoring service, which will observe/reevaluate the current configuration regularly
and trigger ConfigurationChange events if something is changed.
|
void |
fireEvent(ConfigEvent<?> event)
Publishes an event to all interested listeners, hereby executing all registered listeners sequentually and
synchronously
|
void |
fireEventAsynch(ConfigEvent<?> event)
Publishes an event to all interested listeners, hereby publishing the change events asynchrously and in
parallel (multithreaded).
|
long |
getChangeMonitoringPeriod()
Get the current check period to check for configuration changes.
|
Collection<? extends ConfigEventListener> |
getListeners()
Access all globally registered listeners.
|
Collection<? extends ConfigEventListener> |
getListeners(Class<? extends ConfigEvent> eventType)
Access all listeners listening for a certain event type, including any global listeners.
|
boolean |
isChangeMonitorActive()
Check if the observer is running currently.
|
void |
removeListener(ConfigEventListener l)
Removes a listener for observing events.
|
<T extends ConfigEvent> |
removeListener(ConfigEventListener l,
Class<T> eventType)
Removes a listener for observing events of a certain type.
|
void |
setChangeMonitoringPeriod(long millis) |
<T> void addListener(ConfigEventListener l)
T
- the type of the events listened to.l
- the listener not null.<T extends ConfigEvent> void addListener(ConfigEventListener l, Class<T> eventType)
T
- the type of the events listened to.l
- the listener not null.eventType
- the type of concrete configuration event this listeners should be informed about. All other
event types will never be delivered to this listener instance.void removeListener(ConfigEventListener l)
l
- the listener not null.<T extends ConfigEvent> void removeListener(ConfigEventListener l, Class<T> eventType)
T
- the type of the events listened to.l
- the listener not null.eventType
- the type of concrete configuration event this listeners should be informed about. All other
event types will never be delivered toe this listener instance.Collection<? extends ConfigEventListener> getListeners()
Collection<? extends ConfigEventListener> getListeners(Class<? extends ConfigEvent> eventType)
eventType
- the type of concrete configuration event this listeners should be informed about. All other
event types will never be delivered toe this listener instance.void fireEvent(ConfigEvent<?> event)
event
- the event, not null.void fireEventAsynch(ConfigEvent<?> event)
event
- the event, not null.long getChangeMonitoringPeriod()
void setChangeMonitoringPeriod(long millis)
boolean isChangeMonitorActive()
void enableChangeMonitor(boolean enable)
ConfigEventListener
have
to be registered, e.g. listening on ConfigurationChange
events.enable
- whether to enable or disable the change monitoring.Copyright © 2014–2016 Apache Software Foundation. All rights reserved.