Bug 5528 - Read data impl

[netconf.git] / restconf / sal-rest-connector / src / main / java / org / opendaylight / restconf / restful / utils / FutureCallbackTx.java

diff --git a/restconf/sal-rest-connector/src/main/java/org/opendaylight/restconf/restful/utils/FutureCallbackTx.java b/restconf/sal-rest-connector/src/main/java/org/opendaylight/restconf/restful/utils/FutureCallbackTx.java
new file mode 100644 (file)
index 0000000..a2b95fb
--- /dev/null
+++ b/restconf/sal-rest-connector/src/main/java/org/opendaylight/restconf/restful/utils/FutureCallbackTx.java
@@ -0,0 +1,95 @@
+/*
+ * 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.restconf.restful.utils;
+
+import com.google.common.base.Optional;
+import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.util.concurrent.FutureCallback;
+import com.google.common.util.concurrent.Futures;
+import javax.annotation.Nullable;
+import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
+import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Add callback for future objects and result set to the data factory.
+ *
+ */
+final class FutureCallbackTx {
+
+    private final static Logger LOG = LoggerFactory.getLogger(FutureCallbackTx.class);
+
+    private FutureCallbackTx() {
+        throw new UnsupportedOperationException("Util class");
+    }
+
+    /**
+     * Add callback to the future object
+     *
+     * @param listenableFuture
+     *            - future object
+     * @param transaction
+     *            - transaction used for read of future object
+     * @param txType
+     *            - type of operation (READ, POST, PUT, DELETE)
+     * @param dataFactory
+     *            - factory setting result
+     */
+    static void addCallback(final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> listenableFuture,
+            final AsyncTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>> transaction, final String txType,
+            final FutureDataFactory dataFactory) {
+        Futures.addCallback(listenableFuture, new FutureCallback<Optional<NormalizedNode<?, ?>>>() {
+
+            @Override
+            public void onFailure(final Throwable t) {
+                handlingLoggerAndValues(t, txType, transaction, null, null);
+            }
+
+            @Override
+            public void onSuccess(final Optional<NormalizedNode<?, ?>> result) {
+                handlingLoggerAndValues(null, txType, transaction, result, dataFactory);
+            }
+
+        });
+    }
+
+    /**
+     * Handling logger and result of callback - on success or on failure
+     * <ul>
+     * <li>on success - set result to the factory
+     * <li>on failure - throw exception
+     * </ul>
+     *
+     * @param t
+     *            - exception - if callback is onFailure
+     * @param txType
+     *            - type of operation (READ, POST, PUT, DELETE)
+     * @param transaction
+     *            - transaction used for read of future object
+     * @param optionalNN
+     *            - result - if callback is on Success
+     * @param dataFactory
+     *            - setter for result - in callback is onSuccess
+     */
+    protected static void handlingLoggerAndValues(@Nullable final Throwable t, final String txType,
+            final AsyncTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>> transaction,
+            final Optional<NormalizedNode<?, ?>> optionalNN, final FutureDataFactory dataFactory) {
+        if (t != null) {
+            LOG.info("Transaction({}) {} FAILED!", txType, transaction.getIdentifier(), t);
+            throw new IllegalStateException("  Transaction(" + txType + ") not committed correctly", t);
+        } else {
+            LOG.trace("Transaction({}) {} SUCCESSFUL!", txType, transaction.getIdentifier());
+            if (optionalNN.isPresent()) {
+                dataFactory.setData(optionalNN.get());
+            }
+        }
+    }
+}