2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.dom.spi.shard;
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;
18 public interface DOMDataTreeShardWriteTransaction extends DOMDataTreeCursorProvider {
20 * Create a new write cursor. Any previous cursors have to be {@link DOMDataTreeWriteCursor#close()}d.
22 * @param prefix Tree identifier of the apex at which the cursor is rooted.
23 * @return A new cursor rooted at specified prefx.
24 * @throws IllegalStateException if a previous cursor has not been closed.
25 * @throws NullPointerException if prefix is null.
28 // FIXME: 4.0.0: reconcile @NonNull vs. super @Nullable
29 @NonNull DOMDataTreeWriteCursor createCursor(@NonNull DOMDataTreeIdentifier prefix);
32 * Finish this transaction and submit it for processing.
35 * FIXME: this method should accept a callback which will report success/failure. Let's not use a CheckedFuture
36 * due to overhead associated with attaching listeners to them.
37 * @throws IllegalStateException if this transaction has an unclosed cursor.
42 * Close this transaction and all other foreign shard transactions that were opened as a part of this transaction.
46 ListenableFuture<Void> submit();
48 ListenableFuture<Boolean> validate();
50 ListenableFuture<Void> prepare();
52 ListenableFuture<Void> commit();