org.kaaproject.kaa.client.configuration.manager

Interface ConfigurationManager

All Known Implementing Classes:

DefaultConfigurationManager

public interface ConfigurationManager

Interface for the configuration manager.

Responsible for configuration updates subscriptions and configuration obtaining.

Configuration manager can be used to fetch current configuration at any time. If there were no configuration updates, default configuration will be returned. Default configuration is built-in to the sdk.

NOTE: Use ConfigurationPersistenceManager to set configuration storage. Until configuration storage will not be specified each start of Kaa client will cause full configuration resync from Operation server.

 
 // Assuming Kaa inited and started
 ConfigurationManager configurationManager = kaaClient.getConfigurationManager();
 CommonRecord fullCurrentConfiguration = configurationManager.getConfiguration();
 
 

Configuration manager will notify subscribed configuration update observers added using subscribeForConfigurationUpdates(ConfigurationReceiver) on each configuration update received from Operation server.
Use unsubscribeFromConfigurationUpdates(ConfigurationReceiver) when configuration updates aren't needed anymore.

 
 class ConfigurationReceiverImpl implements ConfigurationReceiver {
     public void onConfigurationUpdated(CommonRecord configuration) {
         System.out.println("Configuration received: " + configuration.toString());
     }
 }
 // Assuming Kaa inited
 ConfigurationReceiverImpl receiver = new ConfigurationReceiverImpl();
 ConfigurationManager configurationManager = kaaClient.getConfigurationManager();
 configurationManager.subscribeForConfigurationUpdates(receiver);
 configurationManager.unsubscribeFromConfigurationUpdates(receiver);
 
 

Author:

Yaroslav Zeygerman

See Also:

CommonRecord, ConfigurationReceiver, ConfigurationPersistenceManager

Method Summary

Modifier and Type	Method and Description
CommonRecord	getConfiguration() Retrieves full configuration
void	subscribeForConfigurationUpdates(ConfigurationReceiver receiver) Subscribes for configuration updates. NOTE: Attempting to subscribe two instances of ConfigurationReceiver such as receiver1.equals(receiver2) == true will result the fact that only first instance will be subscribed.
void	unsubscribeFromConfigurationUpdates(ConfigurationReceiver receiver) Unsubscribes from configuration updates. NOTE: Attempting to unsubscribe object which was not subscribed previously will not make any effect.

Method Detail

subscribeForConfigurationUpdates

void subscribeForConfigurationUpdates(ConfigurationReceiver receiver)

Subscribes for configuration updates.

NOTE: Attempting to subscribe two instances of ConfigurationReceiver such as receiver1.equals(receiver2) == true will result the fact that only first instance will be subscribed.

Parameters:

receiver - object to receive updates

See Also:

ConfigurationReceiver

unsubscribeFromConfigurationUpdates

void unsubscribeFromConfigurationUpdates(ConfigurationReceiver receiver)

Unsubscribes from configuration updates.

NOTE: Attempting to unsubscribe object which was not subscribed previously will not make any effect.

Parameters:

receiver - object which is no longer needs configuration updates

See Also:

ConfigurationReceiver

getConfiguration

CommonRecord getConfiguration()

Retrieves full configuration

Returns:

common object with full configuration

See Also:

CommonRecord