Bug 809: Enhancements to the toaster example

[controller.git] / opendaylight / clustering / services / src / main / java / org / opendaylight / controller / clustering / services / IClusterServicesCommon.java

diff --git a/opendaylight/clustering/services/src/main/java/org/opendaylight/controller/clustering/services/IClusterServicesCommon.java b/opendaylight/clustering/services/src/main/java/org/opendaylight/controller/clustering/services/IClusterServicesCommon.java
index e292f73e540ee63aa07b7b28f9904c7d993ca28f..7ea86c6db7d334fc0cd85ac940a76da1c96c7cc0 100644 (file)
--- a/opendaylight/clustering/services/src/main/java/org/opendaylight/controller/clustering/services/IClusterServicesCommon.java
+++ b/opendaylight/clustering/services/src/main/java/org/opendaylight/controller/clustering/services/IClusterServicesCommon.java
@@ -10,7 +10,7 @@
 /**
  * @file   IClusterServicesCommon.java
  *
- * @brief  : Set of services and application will expect from the
+ * @brief  : Set of services an application will expect from the
  * clustering services provider. This interface is going to be the
  * base for per-container and Global services and so the container
  * parameter is omitted but who uses knows about it
@@ -26,6 +26,7 @@ import java.util.List;
 import java.util.Properties;
 import java.util.Set;
 import java.util.concurrent.ConcurrentMap;
+import java.util.concurrent.TimeUnit;
 
 import javax.transaction.HeuristicMixedException;
 import javax.transaction.HeuristicRollbackException;
@@ -35,11 +36,12 @@ import javax.transaction.SystemException;
 import javax.transaction.Transaction;
 
 /**
- * @deprecated for internal use
- * Set of services and application will expect from the
- * clustering services provider. This interface is going to be the
- * base for per-container and Global services and so the container
- * parameter is omitted but who uses knows about it
+ * This WILL NOT BE USED DIRECTLY, but VIA SUBCLASS
+ *
+ * Set of services and application will expect from the clustering services
+ * provider. This interface is going to be the base for per-container and Global
+ * services and so the container parameter is omitted but who uses knows about
+ * it
  *
  */
 public interface IClusterServicesCommon {
@@ -117,6 +119,16 @@ public interface IClusterServicesCommon {
      */
     void tbegin() throws NotSupportedException, SystemException;
 
+    /**
+     * tbegin with a timeout
+     * @see IClusterServicesCommon#tbegin
+     * @param timeout the transaction timeout
+     * @param unit TimeUnit for the timeout
+     * @throws NotSupportedException
+     * @throws SystemException
+     */
+    void tbegin(long timeout, TimeUnit unit) throws NotSupportedException, SystemException;
+
     /**
      * Commit a transaction covering all the data structures/HW updates.
      */