Add new cds-access-api proxies
[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 org.opendaylight.controller.cluster.access.concepts.RequestException;
11
12 /**
13  * A {@link RequestException} indicating that the backend has received a request for a transaction which has already
14  * been closed, either via a successful commit or abort (which is indicated via {@link #isSuccessful()}. This can
15  * happen if the corresponding journal record is replicated, but the message to the frontend gets lost and the backed
16  * leader moved before the frontend retried the corresponding request.
17  */
18 public final class ClosedTransactionException extends RequestException {
19     @java.io.Serial
20     private static final long serialVersionUID = 1L;
21
22     private final boolean successful;
23
24     public ClosedTransactionException(final boolean successful) {
25         super("Transaction has been " + (successful ? "committed" : "aborted"));
26         this.successful = successful;
27     }
28
29     @Override
30     public boolean isRetriable() {
31         return false;
32     }
33
34     public boolean isSuccessful() {
35         return successful;
36     }
37 }