BUG-4202: Initial prototype of subshard aware Shard implementation

[mdsal.git] / dom / mdsal-dom-inmemory-datastore / src / main / java / org / opendaylight / mdsal / dom / store / inmemory / DOMDataTreeShardWriteTransaction.java

diff --git a/dom/mdsal-dom-inmemory-datastore/src/main/java/org/opendaylight/mdsal/dom/store/inmemory/DOMDataTreeShardWriteTransaction.java b/dom/mdsal-dom-inmemory-datastore/src/main/java/org/opendaylight/mdsal/dom/store/inmemory/DOMDataTreeShardWriteTransaction.java
new file mode 100644 (file)
index 0000000..92146bc
--- /dev/null
+++ b/dom/mdsal-dom-inmemory-datastore/src/main/java/org/opendaylight/mdsal/dom/store/inmemory/DOMDataTreeShardWriteTransaction.java
@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 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,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.mdsal.dom.store.inmemory;
+
+import com.google.common.annotations.Beta;
+import javax.annotation.Nonnull;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor;
+
+// FIXME: this should be moved to a separate package
+@Beta
+public interface DOMDataTreeShardWriteTransaction {
+    /**
+     * Create a new write cursor. Any previous cursors have to be {@link DOMDataTreeWriteCursor#close()}d.
+     *
+     * @param prefix Tree identifier of the apex at which the cursor is rooted.
+     * @return A new cursor rooted at specified prefx.
+     * @throws IllegalStateException if a previous cursor has not been closed.
+     * @throws NullPointerException if prefix is null.
+     */
+    @Nonnull DOMDataTreeWriteCursor createCursor(@Nonnull DOMDataTreeIdentifier prefix);
+
+    /**
+     * Finish this transaction and submit it for processing.
+     *
+     * FIXME: this method should accept a callback which will report success/failure. Let's not use a CheckedFuture
+     *        due to overhead associated with attaching listeners to them.
+     * @throws IllegalStateException if this transaction has an unclosed cursor.
+     */
+    void ready();
+}