opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/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.controller.sal.core.spi.data;
   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
  17      * operation, which is to say that whole subtree will be replaced by
  18      * specified path.
  19      *
  20      * If you need add or merge of current object with specified use
  21      * {@link #merge(YangInstanceIdentifier, NormalizedNode)}.
  22      *
  23      *
  24      * @param path
  25      * @param data
  26      *            Data object to be written
  27      *
  28      * @throws IllegalStateException
  29      *             if the client code already sealed transaction and invoked
  30      *             {@link #ready()}
  31      */
  32     void write(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
  33
  34     /**
  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
  37      * specified path.
  38      *
  39      * @param path
  40      * @param data
  41      *            Data object to be written
  42      *
  43      * @throws IllegalStateException
  44      *             if the client code already sealed transaction and invoked
  45      *             {@link #ready()}
  46      */
  47     void merge(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
  48
  49     /**
  50      *
  51      * Deletes data and whole subtree located at provided path.
  52      *
  53      * @param path
  54      *            Path to delete
  55      * @throws IllegalStateException
  56      *             if the client code already sealed transaction and invoked
  57      *             {@link #ready()}
  58      */
  59     void delete(YangInstanceIdentifier path);
  60
  61     /**
  62      *
  63      * Seals transaction, and returns three-phase commit cohort associated
  64      * with this transaction and DOM Store to be coordinated by coordinator.
  65      *
  66      * @return Three Phase Commit Cohort instance for this transaction.
  67      */
  68     DOMStoreThreePhaseCommitCohort ready();
  69
  70 }