2 * Copyright (c) 2014 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.controller.sal.core.spi.data;
10 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
11 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
13 public interface DOMStoreWriteTransaction extends DOMStoreTransaction {
16 * Store a provided data at specified path. This acts as a add / replace
17 * operation, which is to say that whole subtree will be replaced by
21 * If you need add or merge of current object with specified use
22 * {@link #merge(YangInstanceIdentifier, NormalizedNode)}.
24 * @param path the path to write
25 * @param data data object to be written
26 * @throws IllegalStateException
27 * if the client code already sealed transaction and invoked
30 void write(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
33 * Store a provided data at specified path. This acts as a add / replace
34 * operation, which is to say that whole subtree will be replaced by
37 * @param path the path to write
38 * @param data data object to be written
39 * @throws IllegalStateException
40 * if the client code already sealed transaction and invoked
43 void merge(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
46 * Deletes data and whole subtree located at provided path.
48 * @param path path to delete
49 * @throws IllegalStateException
50 * if the client code already sealed transaction and invoked
53 void delete(YangInstanceIdentifier path);
56 * Seals transaction, and returns three-phase commit cohort associated
57 * with this transaction and DOM Store to be coordinated by coordinator.
59 * @return Three Phase Commit Cohort instance for this transaction.
61 DOMStoreThreePhaseCommitCohort ready();