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
9 package org.opendaylight.mdsal.dom.store.inmemory;
11 import com.google.common.annotations.Beta;
12 import com.google.common.util.concurrent.ListenableFuture;
13 import javax.annotation.Nonnull;
14 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
15 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor;
17 // FIXME: this should be moved to a separate package
19 public interface DOMDataTreeShardWriteTransaction {
21 * Create a new write cursor. Any previous cursors have to be {@link DOMDataTreeWriteCursor#close()}d.
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.
28 @Nonnull DOMDataTreeWriteCursor createCursor(@Nonnull DOMDataTreeIdentifier prefix);
31 * Finish this transaction and submit it for processing.
33 * FIXME: this method should accept a callback which will report success/failure. Let's not use a CheckedFuture
34 * due to overhead associated with attaching listeners to them.
35 * @throws IllegalStateException if this transaction has an unclosed cursor.
40 * Close this transaction and all other foreign shard transactions that were opened as a part of this transaction.
44 ListenableFuture<Void> submit();
46 //FIXME: remove these from the public api?
47 ListenableFuture<Boolean> validate();
49 ListenableFuture<Void> prepare();
51 ListenableFuture<Void> commit();