org.opendaylight.restconf.restful.utils.FutureCallbackTx.java Source code

Introduction

Here is the source code for org.opendaylight.restconf.restful.utils.FutureCallbackTx.java

Source

/*
 * 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.util.concurrent.CheckedFuture;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import javax.annotation.Nullable;
import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
import org.opendaylight.netconf.sal.restconf.impl.RestconfDocumentedException;
import org.opendaylight.yangtools.yang.common.RpcError;
import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
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 txType
     *            - type of operation (READ, POST, PUT, DELETE)
     * @param dataFactory
     *            - factory setting result
     */
    static <T, X extends Exception> void addCallback(final CheckedFuture<T, X> listenableFuture,
            final String txType, final FutureDataFactory<T> dataFactory) {
        final CountDownLatch responseWaiter = new CountDownLatch(1);
        Futures.addCallback(listenableFuture, new FutureCallback<T>() {

            @Override
            public void onFailure(final Throwable t) {
                responseWaiter.countDown();
                handlingLoggerAndValues(t, txType, null, dataFactory);
            }

            @Override
            public void onSuccess(final T result) {
                handlingLoggerAndValues(null, txType, result, dataFactory);
                responseWaiter.countDown();
            }

        });
        try {
            responseWaiter.await();
        } catch (final Exception e) {
            final String msg = "Problem while waiting for response";
            LOG.warn(msg);
            throw new RestconfDocumentedException(msg, e);
        }
    }

    /**
     * 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 result
     *            - result of future - if callback is on Success
     * @param dataFactory
     *            - setter for result - in callback is onSuccess
     */
    protected static <T> void handlingLoggerAndValues(@Nullable final Throwable t, final String txType,
            final T result, final FutureDataFactory<T> dataFactory) {
        if (t != null) {
            dataFactory.setFailureStatus();
            LOG.warn("Transaction({}) FAILED!", txType, t);
            if (t instanceof DOMRpcException) {
                final List<RpcError> rpcErrorList = new ArrayList<>();
                rpcErrorList
                        .add(RpcResultBuilder.newError(RpcError.ErrorType.RPC, "operation-failed", t.getMessage()));
                dataFactory.setResult((T) new DefaultDOMRpcResult(rpcErrorList));
            } else {
                throw new RestconfDocumentedException("  Transaction(" + txType + ") not committed correctly", t);
            }
        } else {
            LOG.trace("Transaction({}) SUCCESSFUL!", txType);
            dataFactory.setResult(result);
        }
    }
}