opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/LocalAbortable.java

   1 /*
   2  * Copyright (c) 2016 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.cluster.databroker.actors.dds;
   9
  10 /**
  11  * Common interface for client histories and client transactions, which can be aborted immediately without replicating
  12  * the effect to the backend. This is needed for abrupt shutdowns.
  13  *
  14  * <p>
  15  * Since classes which need to expose this functionality do not need a base class, this is an abstract class and not
  16  * an interface -- which allows us to not leak the {@link #localAbort(Throwable)} method.
  17  *
  18  * @author Robert Varga
  19  */
  20 abstract class LocalAbortable {
  21     /**
  22      * Immediately abort this object.
  23      *
  24      * @param cause Failure which caused this abort.
  25      */
  26     abstract void localAbort(Throwable cause);
  27 }