Per container save configuration is not synced in the cluster

[controller.git] / opendaylight / configuration / api / src / main / java / org / opendaylight / controller / configuration / IConfigurationServiceCommon.java

diff --git a/opendaylight/configuration/api/src/main/java/org/opendaylight/controller/configuration/IConfigurationServiceCommon.java b/opendaylight/configuration/api/src/main/java/org/opendaylight/controller/configuration/IConfigurationServiceCommon.java
index c76e3770264aecbf32499eb876502ea9b6daccf1..05eed6f23f78bc807becfac9bf98f7abc43bb719 100644 (file)
--- a/opendaylight/configuration/api/src/main/java/org/opendaylight/controller/configuration/IConfigurationServiceCommon.java
+++ b/opendaylight/configuration/api/src/main/java/org/opendaylight/controller/configuration/IConfigurationServiceCommon.java
@@ -12,10 +12,19 @@ package org.opendaylight.controller.configuration;
 import org.opendaylight.controller.sal.utils.Status;
 
 /**
- * Container Manager interface
- *
- *
+ * Common configuration interface for Configuration Service and Container
+ * Configuration Service
  */
 public interface IConfigurationServiceCommon {
+    /**
+     * Represent the trigger to save the controller configuration cluster wide.
+     * When called on IConfigurationService, it will trigger a cluster wide save
+     * configuration event for all the global instance components and all
+     * components in all containers. When called on
+     * IContainerConfigurationService, it will trigger a cluster wide save
+     * configuration event for all components in the current container.
+     *
+     * @return the Status object representing the result of the saving request
+     */
     Status saveConfigurations();
 }