opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/data/DataModificationTransaction.java

   1 /*
   2  * Copyright (c) 2013 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.api.data;
   9
  10 import java.util.EventListener;
  11 import java.util.concurrent.Future;
  12
  13 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  14 import org.opendaylight.controller.md.sal.common.api.data.DataModification;
  15 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  16 import org.opendaylight.yangtools.yang.common.RpcResult;
  17 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  18 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
  19
  20 public interface DataModificationTransaction extends DataModification<InstanceIdentifier, CompositeNode>{
  21
  22     /**
  23      * Returns transaction identifier
  24      *
  25      * @return Transaction identifier
  26      */
  27     @Override
  28     Object getIdentifier();
  29
  30     @Override
  31     TransactionStatus getStatus();
  32
  33     /**
  34      * Commits transaction to be stored in global data repository.
  35      *
  36      *
  37      * @return  Future object which returns RpcResult with TransactionStatus
  38      *          when transaction is processed by store.
  39      */
  40     @Override
  41     Future<RpcResult<TransactionStatus>> commit();
  42
  43     ListenerRegistration<DataTransactionListener> registerListener(DataTransactionListener listener);
  44
  45     public interface DataTransactionListener extends EventListener {
  46         void onStatusUpdated(DataModificationTransaction transaction,TransactionStatus status);
  47     }
  48 }