Implement managed transactions

[mdsal.git] / binding / mdsal-binding-util / src / main / java / org / opendaylight / mdsal / binding / util / TypedWriteTransaction.java

diff --git a/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/TypedWriteTransaction.java b/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/TypedWriteTransaction.java
new file mode 100644 (file)
index 0000000..f8be2a4
--- /dev/null
+++ b/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/TypedWriteTransaction.java
@@ -0,0 +1,80 @@
+/*
+ * Copyright © 2018 Red Hat, Inc. and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.mdsal.binding.util;
+
+import org.opendaylight.mdsal.binding.api.Transaction;
+import org.opendaylight.mdsal.binding.api.WriteTransaction;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Write transaction which is specific to a single logical datastore (configuration or operational). Designed for use
+ * with {@link ManagedNewTransactionRunner} (it doesn’t support explicit cancel or commit operations).
+ *
+ * @param <D> The logical datastore handled by the transaction.
+ * @see WriteTransaction
+ */
+public interface TypedWriteTransaction<D extends Datastore> extends Transaction {
+    /**
+     * Writes an object to the given path.
+     *
+     * @see WriteTransaction#put(LogicalDatastoreType, InstanceIdentifier, DataObject)
+     *
+     * @param path The path to write to.
+     * @param data The object to write.
+     * @param <T> The type of the provided object.
+     */
+    <T extends DataObject> void put(InstanceIdentifier<T> path, T data);
+
+    /**
+     * Writes an object to the given path, creating missing parents if requested.
+     *
+     * @see WriteTransaction#put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)
+     *
+     * @param path The path to write to.
+     * @param data The object to write.
+     * @param createMissingParents {@link WriteTransaction#CREATE_MISSING_PARENTS} to create missing parents,
+     * {@link WriteTransaction#FAIL_ON_MISSING_PARENTS} to fail if parents are missing.
+     * @param <T> The type of the provided object.
+     */
+    <T extends DataObject> void put(InstanceIdentifier<T> path, T data, boolean createMissingParents);
+
+    /**
+     * Merges an object with the data already present at the given path.
+     *
+     * @see WriteTransaction#merge(LogicalDatastoreType, InstanceIdentifier, DataObject)
+     *
+     * @param path The path to write to.
+     * @param data The object to merge.
+     * @param <T> The type of the provided object.
+     */
+    <T extends DataObject> void merge(InstanceIdentifier<T> path, T data);
+
+    /**
+     * Merges an object with the data already present at the given path, creating missing parents if requested.
+     *
+     * @see WriteTransaction#merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)
+     *
+     * @param path The path to write to.
+     * @param data The object to merge.
+     * @param createMissingParents {@link WriteTransaction#CREATE_MISSING_PARENTS} to create missing parents,
+     * {@link WriteTransaction#FAIL_ON_MISSING_PARENTS} to fail if parents are missing.
+     * @param <T> The type of the provided object.
+     */
+    <T extends DataObject> void merge(InstanceIdentifier<T> path, T data, boolean createMissingParents);
+
+    /**
+     * Deletes the object present at the given path.
+     *
+     * @see WriteTransaction#delete(LogicalDatastoreType, InstanceIdentifier)
+     *
+     * @param path The path to delete.
+     */
+    void delete(InstanceIdentifier<?> path);
+}