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.InstanceIdentifier;
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
20 * If you need add or merge of current object with specified use
21 * {@link #merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.concepts.Path, Object)}
26 * Data object to be written
28 * @throws IllegalStateException
29 * if the client code already sealed transaction and invoked
32 void write(InstanceIdentifier path, NormalizedNode<?, ?> data);
35 * Store a provided data at specified path. This acts as a add / replace
36 * operation, which is to say that whole subtree will be replaced by
39 * If you need add or merge of current object with specified use
40 * {@link #merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.concepts.Path, Object)}
45 * Data object to be written
47 * @throws IllegalStateException
48 * if the client code already sealed transaction and invoked
51 void merge(InstanceIdentifier path, NormalizedNode<?, ?> data);
55 * Deletes data and whole subtree located at provided path.
59 * @throws IllegalStateException
60 * if the client code already sealed transaction and invoked
63 void delete(InstanceIdentifier path);
67 * Seals transaction, and returns three-phase commit cohort associated
68 * with this transaction and DOM Store to be coordinated by coordinator.
70 * @return Three Phase Commit Cohort instance for this transaction.
72 DOMStoreThreePhaseCommitCohort ready();