openstack/net-virt-it/src/test/java/org/opendaylight/ovsdb/openstack/netvirt/it/MdsalUtils.java

   1 /*
   2  * Copyright (c) 2015 Red Hat, 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.ovsdb.openstack.netvirt.it;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  13 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  14 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  16 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  17 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  18 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  19 import org.slf4j.Logger;
  20 import org.slf4j.LoggerFactory;
  21
  22 /**
  23  * Utility class for mdsal transactions.
  24  *
  25  * @author Sam Hague (shague@redhat.com)
  26  */
  27 public class MdsalUtils {
  28     private static final Logger LOG = LoggerFactory.getLogger(MdsalUtils.class);
  29     private DataBroker databroker = null;
  30
  31     /**
  32      * Class constructor setting the data broker.
  33      *
  34      * @param dataBroker the {@link DataBroker}
  35      */
  36     public MdsalUtils(DataBroker dataBroker) {
  37         this.databroker = dataBroker;
  38     }
  39
  40     /**
  41      * Executes delete as a blocking transaction.
  42      *
  43      * @param store {@link LogicalDatastoreType} which should be modified
  44      * @param path {@link InstanceIdentifier} to read from
  45      * @param <D> the data object type
  46      * @return the result of the request
  47      */
  48     public <D extends org.opendaylight.yangtools.yang.binding.DataObject> boolean delete(
  49             final LogicalDatastoreType store, final InstanceIdentifier<D> path)  {
  50         boolean result = false;
  51         final WriteTransaction transaction = databroker.newWriteOnlyTransaction();
  52         transaction.delete(store, path);
  53         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
  54         try {
  55             future.checkedGet();
  56             result = true;
  57         } catch (TransactionCommitFailedException e) {
  58             LOG.warn("Failed to delete {} ", path, e);
  59         }
  60         return result;
  61     }
  62
  63     /**
  64      * Executes merge as a blocking transaction.
  65      *
  66      * @param logicalDatastoreType {@link LogicalDatastoreType} which should be modified
  67      * @param path {@link InstanceIdentifier} for path to read
  68      * @param <D> the data object type
  69      * @return the result of the request
  70      */
  71     public <D extends org.opendaylight.yangtools.yang.binding.DataObject> boolean merge(
  72             final LogicalDatastoreType logicalDatastoreType, final InstanceIdentifier<D> path, D data)  {
  73         boolean result = false;
  74         final WriteTransaction transaction = databroker.newWriteOnlyTransaction();
  75         transaction.merge(logicalDatastoreType, path, data, true);
  76         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
  77         try {
  78             future.checkedGet();
  79             result = true;
  80         } catch (TransactionCommitFailedException e) {
  81             LOG.warn("Failed to merge {} ", path, e);
  82         }
  83         return result;
  84     }
  85
  86     /**
  87      * Executes put as a blocking transaction.
  88      *
  89      * @param logicalDatastoreType {@link LogicalDatastoreType} which should be modified
  90      * @param path {@link InstanceIdentifier} for path to read
  91      * @param <D> the data object type
  92      * @return the result of the request
  93      */
  94     public <D extends org.opendaylight.yangtools.yang.binding.DataObject> boolean put(
  95             final LogicalDatastoreType logicalDatastoreType, final InstanceIdentifier<D> path, D data)  {
  96         boolean result = false;
  97         final WriteTransaction transaction = databroker.newWriteOnlyTransaction();
  98         transaction.put(logicalDatastoreType, path, data, true);
  99         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
 100         try {
 101             future.checkedGet();
 102             result = true;
 103         } catch (TransactionCommitFailedException e) {
 104             LOG.warn("Failed to put {} ", path, e);
 105         }
 106         return result;
 107     }
 108
 109     /**
 110      * Executes read as a blocking transaction.
 111      *
 112      * @param store {@link LogicalDatastoreType} to read
 113      * @param path {@link InstanceIdentifier} for path to read
 114      * @param <D> the data object type
 115      * @return the result as the data object requested
 116      */
 117     public <D extends org.opendaylight.yangtools.yang.binding.DataObject> D read(
 118             final LogicalDatastoreType store, final InstanceIdentifier<D> path)  {
 119         D result = null;
 120         final ReadOnlyTransaction transaction = databroker.newReadOnlyTransaction();
 121         Optional<D> optionalDataObject;
 122         CheckedFuture<Optional<D>, ReadFailedException> future = transaction.read(store, path);
 123         try {
 124             optionalDataObject = future.checkedGet();
 125             if (optionalDataObject.isPresent()) {
 126                 result = optionalDataObject.get();
 127             } else {
 128                 LOG.debug("{}: Failed to read {}",
 129                         Thread.currentThread().getStackTrace()[1], path);
 130             }
 131         } catch (ReadFailedException e) {
 132             LOG.warn("Failed to read {} ", path, e);
 133         }
 134         transaction.close();
 135         return result;
 136     }
 137 }