BUG-5280: introduce base Transaction request/success

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

diff --git a/opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/ReadTransactionSuccess.java b/opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/ReadTransactionSuccess.java
new file mode 100644 (file)
index 0000000..e83adee
--- /dev/null
+++ b/opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/ReadTransactionSuccess.java
@@ -0,0 +1,51 @@
+/*
+ * 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 com.google.common.annotations.Beta;
+import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
+import org.opendaylight.controller.cluster.access.ABIVersion;
+import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+
+/**
+ * Successful reply to an {@link ReadTransactionRequest}. It indicates presence of requested data via {@link #getData()}.
+ *
+ * @author Robert Varga
+ */
+@Beta
+public final class ReadTransactionSuccess extends TransactionSuccess<ReadTransactionSuccess> {
+    private static final long serialVersionUID = 1L;
+    private final Optional<NormalizedNode<?, ?>> data;
+
+    public ReadTransactionSuccess(final TransactionIdentifier identifier, final long sequence,
+            final Optional<NormalizedNode<?, ?>> data) {
+        this(identifier, sequence, 0, data);
+    }
+
+    ReadTransactionSuccess(final TransactionIdentifier identifier, final long sequence, final long retry,
+            final Optional<NormalizedNode<?, ?>> data) {
+        super(identifier, sequence, retry);
+        this.data = Preconditions.checkNotNull(data);
+    }
+
+    public Optional<NormalizedNode<?, ?>> getData() {
+        return data;
+    }
+
+    @Override
+    protected AbstractTransactionSuccessProxy<ReadTransactionSuccess> externalizableProxy(final ABIVersion version) {
+        return new ReadTransactionSuccessProxyV1(this);
+    }
+
+    @Override
+    protected ReadTransactionSuccess cloneAsVersion(final ABIVersion version) {
+        return this;
+    }
+}