binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/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.mdsal.binding.api;
   9
  10 import java.util.EventListener;
  11
  12 /**
  13  * Listener for transaction chain events.
  14  */
  15 // FIXME: 4.0.0: remove this in favor of a TransactionChain destiny, available as a FluentFuture from TransactionChain
  16 public interface TransactionChainListener extends EventListener {
  17     /**
  18      * Invoked if when a transaction in the chain fails. All transactions submitted after the failed transaction, in the
  19      * chain, are automatically cancelled by the time this notification is invoked. Open transactions need to be closed
  20      * or cancelled.
  21      * Implementations should invoke chain.close() to close the chain.
  22      *
  23      * @param chain Transaction chain which failed
  24      * @param transaction Transaction which caused the chain to fail
  25      * @param cause The cause of transaction failure
  26      */
  27     void onTransactionChainFailed(TransactionChain chain, Transaction transaction, Throwable cause);
  28
  29     /**
  30      * Invoked when a transaction chain is completed. A transaction chain is considered completed when it has been
  31      * closed and all its instructions have completed successfully.
  32      *
  33      * @param chain Transaction chain which completed
  34      */
  35     void onTransactionChainSuccessful(TransactionChain chain);
  36 }
  37