org.eclipse.swordfish.core.configuration
Interface ConfigurationConsumer<T>

All Known Implementing Classes:
AbstractDocumentProvider, FilesystemDocumentProvider, FilesystemPolicyDefinitionProvider, SwordfishRegistryProvider

public interface ConfigurationConsumer<T>

Indicates that the implementor will be aware of the configuration updates Can be plugged into the Swordfish framework as an osgi service with the interface name org.eclipse.swordfish.api.configuration.ConfigurationConsumer to receive notifications about the change in the configuration.


Method Summary
 java.lang.String getId()
          Uniquely identifies the configuration
 void onReceiveConfiguration(java.util.Map<java.lang.String,T> configuration)
          The callback method invoked by the Swordfish environment when the configuration is changed
 

Method Detail

getId

java.lang.String getId()
Uniquely identifies the configuration

Returns:
the identifier String, expected to be unique among all registered ConfigurationConsumer instances registered to the system. Must not be null or an empty String.

onReceiveConfiguration

void onReceiveConfiguration(java.util.Map<java.lang.String,T> configuration)
The callback method invoked by the Swordfish environment when the configuration is changed

Parameters:
configuration - the new/updated configuration.