opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChainListener.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.md.sal.common.api.data;
   9
  10 import java.util.EventListener;
  11
  12 /**
  13  * Listener for transaction chain events.
  14  */
  15 @Deprecated(forRemoval = true)
  16 public interface TransactionChainListener extends EventListener {
  17     /**
  18      * Invoked if when a transaction in the chain fails. All other transactions are automatically cancelled by the time
  19      * this notification is invoked. Implementations should invoke chain.close() to close the chain.
  20      *
  21      * @param chain Transaction chain which failed
  22      * @param transaction Transaction which caused the chain to fail
  23      * @param cause The cause of transaction failure
  24      */
  25     void onTransactionChainFailed(TransactionChain<?, ?> chain, AsyncTransaction<?, ?> transaction, Throwable cause);
  26
  27     /**
  28      * Invoked when a transaction chain is completed. A transaction chain is considered completed when it has been
  29      * closed and all its instructions have completed successfully.
  30      *
  31      * @param chain Transaction chain which completed
  32      */
  33     void onTransactionChainSuccessful(TransactionChain<?, ?> chain);
  34 }
  35