dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/shard/DOMDataTreeShardWriteTransaction.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.dom.spi.shard;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.mdsal.dom.api.DOMDataTreeCursorProvider;
  14 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  15 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor;
  16
  17 @Beta
  18 @Deprecated(forRemoval = true)
  19 public interface DOMDataTreeShardWriteTransaction extends DOMDataTreeCursorProvider {
  20     /**
  21      * Create a new write cursor. Any previous cursors have to be {@link DOMDataTreeWriteCursor#close()}d.
  22      *
  23      * @param prefix Tree identifier of the apex at which the cursor is rooted.
  24      * @return A new cursor rooted at specified prefx.
  25      * @throws IllegalStateException if a previous cursor has not been closed.
  26      * @throws NullPointerException if prefix is null.
  27      */
  28     @Override
  29     // FIXME: 6.0.0: reconcile @NonNull vs. super @Nullable
  30     @NonNull DOMDataTreeWriteCursor createCursor(@NonNull DOMDataTreeIdentifier prefix);
  31
  32     /**
  33      * Finish this transaction and submit it for processing.
  34      *
  35      *<p>
  36      * FIXME: this method should accept a callback which will report success/failure. Let's not use a CheckedFuture
  37      *        due to overhead associated with attaching listeners to them.
  38      * @throws IllegalStateException if this transaction has an unclosed cursor.
  39      */
  40     void ready();
  41
  42     /**
  43      * Close this transaction and all other foreign shard transactions that were opened as a part of this transaction.
  44      */
  45     void close();
  46
  47     ListenableFuture<Void> submit();
  48
  49     ListenableFuture<Boolean> validate();
  50
  51     ListenableFuture<Void> prepare();
  52
  53     ListenableFuture<Void> commit();
  54
  55 }