dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/store/DOMStoreWriteTransaction.java

   1 /*
   2  * Copyright (c) 2014 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.store;
   9
  10 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  11 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  12
  13 public interface DOMStoreWriteTransaction extends DOMStoreTransaction {
  14
  15     /**
  16      * Store a provided data at specified path. This acts as a add / replace operation, which is to
  17      * say that whole subtree will be replaced by specified path.
  18      *
  19      * If you need add or merge of current object with specified use
  20      * {@link #merge(YangInstanceIdentifier, NormalizedNode)}
  21      *
  22      *
  23      * @param path
  24      * @param data Data object to be written
  25      *
  26      * @throws IllegalStateException if the client code already sealed transaction and invoked
  27      *         {@link #ready()}
  28      */
  29     void write(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
  30
  31     /**
  32      * Store a provided data at specified path. This acts as a add / replace operation, which is to
  33      * say that whole subtree will be replaced by specified path.
  34      *
  35      * If you need add or merge of current object with specified use
  36      * {@link #merge(YangInstanceIdentifier, NormalizedNode)}
  37      *
  38      * @param path
  39      * @param data Data object to be written
  40      *
  41      * @throws IllegalStateException if the client code already sealed transaction and invoked
  42      *         {@link #ready()}
  43      */
  44     void merge(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
  45
  46     /**
  47      *
  48      * Deletes data and whole subtree located at provided path.
  49      *
  50      * @param path
  51      *            Path to delete
  52      * @throws IllegalStateException
  53      *             if the client code already sealed transaction and invoked
  54      *             {@link #ready()}
  55      */
  56     void delete(YangInstanceIdentifier path);
  57
  58     /**
  59      *
  60      * Seals transaction, and returns three-phase commit cohort associated
  61      * with this transaction and DOM Store to be coordinated by coordinator.
  62      *
  63      * @return Three Phase Commit Cohort instance for this transaction.
  64      */
  65     DOMStoreThreePhaseCommitCohort ready();
  66
  67 }