MD-SAL API integration

[ovsdb.git] / southbound / southbound-impl / src / main / java / org / opendaylight / ovsdb / southbound / ovsdb / transact / TransactCommand.java

diff --git a/southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/ovsdb/transact/TransactCommand.java b/southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/ovsdb/transact/TransactCommand.java
index c720ba957bf16d6331538591667bc4aeb0755fac..d1bbdd8e5c5d2454175dfe4fa66058262e4a4412 100644 (file)
--- a/southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/ovsdb/transact/TransactCommand.java
+++ b/southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/ovsdb/transact/TransactCommand.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2014, 2016 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -7,10 +7,39 @@
  */
 package org.opendaylight.ovsdb.southbound.ovsdb.transact;
 
+import java.util.Collection;
+import org.opendaylight.mdsal.binding.api.DataTreeModification;
 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
+import org.opendaylight.ovsdb.southbound.InstanceIdentifierCodec;
+import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
 
+/**
+ * Contract for a transactional command.
+ */
 public interface TransactCommand {
+    /**
+     * Queue the command defined by the class implementing this interface in the given transaction builder, with the
+     * given bridge state, in reaction to the given events.
+     *
+     * @param transaction The transaction builder.
+     * @param state The bridge state.
+     * @param events The events to be represented.
+     * @param instanceIdentifierCodec The instance identifier codec to use.
+     */
+    void execute(TransactionBuilder transaction, BridgeOperationalState state,
+                 DataChangeEvent events,
+                 InstanceIdentifierCodec instanceIdentifierCodec);
 
-    public void execute(TransactionBuilder transaction);
-
+    /**
+     * Queue the command defined by the class implementing this interface in the given transaction builder, with the
+     * given bridge state, in reaction to the given modifications.
+     *
+     * @param transaction The transaction builder.
+     * @param state The bridge state.
+     * @param modifications The modifications to be represented.
+     * @param instanceIdentifierCodec The instance identifier codec to use.
+     */
+    void execute(TransactionBuilder transaction, BridgeOperationalState state,
+                 Collection<DataTreeModification<Node>> modifications,
+                 InstanceIdentifierCodec instanceIdentifierCodec);
 }