restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/handlers/TransactionChainHandler.java

   1 /*
   2  * Copyright (c) 2016 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.restconf.nb.rfc8040.handlers;
   9
  10 import java.util.Objects;
  11 import java.util.Queue;
  12 import java.util.concurrent.ConcurrentLinkedQueue;
  13 import javax.annotation.PreDestroy;
  14 import javax.inject.Inject;
  15 import javax.inject.Singleton;
  16 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  17 import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction;
  18 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  19 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
  20 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  21 import org.slf4j.Logger;
  22 import org.slf4j.LoggerFactory;
  23
  24 /**
  25  * Implementation of {@link TransactionChainHandler}.
  26  */
  27 // FIXME: untangle this class, what good is it, really?!
  28 @Singleton
  29 public class TransactionChainHandler implements AutoCloseable {
  30     private static final Logger LOG = LoggerFactory.getLogger(TransactionChainHandler.class);
  31
  32     private final DOMTransactionChainListener transactionChainListener = new DOMTransactionChainListener() {
  33         @Override
  34         public void onTransactionChainFailed(final DOMTransactionChain chain, final DOMDataTreeTransaction transaction,
  35                 final Throwable cause) {
  36             LOG.warn("TransactionChain({}) {} FAILED!", chain, transaction.getIdentifier(), cause);
  37             transactionChainList.remove(chain);
  38             throw new RestconfDocumentedException("TransactionChain(" + chain + ") not committed correctly", cause);
  39         }
  40
  41         @Override
  42         public void onTransactionChainSuccessful(final DOMTransactionChain chain) {
  43             LOG.trace("TransactionChain({}) SUCCESSFUL", chain);
  44             transactionChainList.remove(chain);
  45         }
  46     };
  47
  48     private final DOMDataBroker dataBroker;
  49     private final Queue<DOMTransactionChain> transactionChainList;
  50
  51     /**
  52      * Prepare transaction chain service for Restconf services.
  53      */
  54     @Inject
  55     public TransactionChainHandler(final DOMDataBroker dataBroker) {
  56         this.dataBroker = Objects.requireNonNull(dataBroker);
  57         this.transactionChainList = new ConcurrentLinkedQueue<>();
  58     }
  59
  60     /**
  61      * Create and return new instance of object {@link DOMTransactionChain}.
  62      * After use, is important to close transactionChain by method {@link DOMTransactionChain#close()}.
  63      * @return new instance of object {@link DOMTransactionChain}
  64      */
  65     public DOMTransactionChain get() {
  66         final DOMTransactionChain transactionChain = dataBroker.createTransactionChain(transactionChainListener);
  67         this.transactionChainList.add(transactionChain);
  68         LOG.trace("Started TransactionChain({})", transactionChain);
  69         return transactionChain;
  70     }
  71
  72     @Override
  73     @PreDestroy
  74     public synchronized void close() {
  75         for (DOMTransactionChain transactionChain : this.transactionChainList) {
  76             transactionChain.close();
  77             LOG.trace("Closed TransactionChain({})", transactionChain);
  78         }
  79     }
  80
  81     /**
  82      * Verify if {@link DOMTransactionChain} exist in {@link TransactionChainHandler} queue.
  83      * @param transactionChain object to check.
  84      * @return true if object still exist in {@link TransactionChainHandler}.
  85      */
  86     boolean verifyIfExistTransactionChain(DOMTransactionChain transactionChain) {
  87         return this.transactionChainList.contains(transactionChain);
  88     }
  89 }