BUG-5280: add frontend state lifecycle
[controller.git] / opendaylight / md-sal / cds-access-api / src / main / java / org / opendaylight / controller / cluster / access / commands / ClosedTransactionException.java
1 /*
2  * Copyright (c) 2017 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.access.commands;
9
10 import com.google.common.annotations.Beta;
11 import org.opendaylight.controller.cluster.access.concepts.RequestException;
12
13 /**
14  * A {@link RequestException} indicating that the backend has received a request for a transaction which has already
15  * been closed, either via a successful commit or abort (which is indicated via {@link #isSuccessful()}. This can
16  * happen if the corresponding journal record is replicated, but the message to the frontend gets lost and the backed
17  * leader moved before the frontend retried the corresponding request.
18  *
19  * @author Robert Varga
20  */
21 @Beta
22 public final class ClosedTransactionException extends RequestException {
23     private static final long serialVersionUID = 1L;
24
25     private final boolean successful;
26
27     public ClosedTransactionException(final boolean successful) {
28         super("Transaction has been " + (successful ? "committed" : "aborted"));
29         this.successful = successful;
30     }
31
32     @Override
33     public boolean isRetriable() {
34         return false;
35     }
36
37     public boolean isSuccessful() {
38         return successful;
39     }
40 }