BUG-5280: introduce base Transaction request/success

[controller.git] / opendaylight / md-sal / cds-access-api / src / main / java / org / opendaylight / controller / cluster / access / commands / TransactionRequest.java

diff --git a/opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/TransactionRequest.java b/opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/TransactionRequest.java
new file mode 100644 (file)
index 0000000..6a4a26b
--- /dev/null
+++ b/opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/TransactionRequest.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.cluster.access.commands;
+
+import akka.actor.ActorRef;
+import com.google.common.annotations.Beta;
+import org.opendaylight.controller.cluster.access.ABIVersion;
+import org.opendaylight.controller.cluster.access.concepts.Request;
+import org.opendaylight.controller.cluster.access.concepts.RequestException;
+import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
+
+/**
+ * Abstract base class for {@link Request}s involving specific transaction. This class is visible outside of this
+ * package solely for the ability to perform a unified instanceof check.
+ *
+ * @author Robert Varga
+ *
+ * @param <T> Message type
+ */
+@Beta
+public abstract class TransactionRequest<T extends TransactionRequest<T>> extends Request<TransactionIdentifier, T> {
+    private static final long serialVersionUID = 1L;
+
+    TransactionRequest(final TransactionIdentifier identifier, final long sequence, final long retry,
+        final ActorRef replyTo) {
+        super(identifier, sequence, retry, replyTo);
+    }
+
+    TransactionRequest(final T request, final ABIVersion version) {
+        super(request, version);
+    }
+
+    TransactionRequest(final T request, final long retry) {
+        super(request, retry);
+    }
+
+    @Override
+    public final TransactionFailure toRequestFailure(final RequestException cause) {
+        return new TransactionFailure(getTarget(), getSequence(), getRetry(), cause);
+    }
+
+    @Override
+    protected abstract AbstractTransactionRequestProxy<T> externalizableProxy(final ABIVersion version);
+}