opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/BrokerFacade.java

   1 /**
   2  * Copyright (c) 2014 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.controller.sal.restconf.impl;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  13 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  14 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  15 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  16 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
  17 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation;
  18 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  25 import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
  26 import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorTag;
  27 import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorType;
  28 import org.opendaylight.controller.sal.streams.listeners.ListenerAdapter;
  29 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  30 import org.opendaylight.yangtools.yang.common.QName;
  31 import org.opendaylight.yangtools.yang.common.RpcResult;
  32 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 import javax.ws.rs.core.Response.Status;
  40 import java.util.ArrayList;
  41 import java.util.Iterator;
  42 import java.util.List;
  43 import java.util.concurrent.Future;
  44
  45 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.CONFIGURATION;
  46 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.OPERATIONAL;
  47
  48 public class BrokerFacade {
  49     private final static Logger LOG = LoggerFactory.getLogger(BrokerFacade.class);
  50
  51     private final static BrokerFacade INSTANCE = new BrokerFacade();
  52     private volatile ConsumerSession context;
  53     private DOMDataBroker domDataBroker;
  54
  55     private BrokerFacade() {
  56     }
  57
  58     public void setContext(final ConsumerSession context) {
  59         this.context = context;
  60     }
  61
  62     public static BrokerFacade getInstance() {
  63         return BrokerFacade.INSTANCE;
  64     }
  65
  66     private void checkPreconditions() {
  67         if (context == null || domDataBroker == null) {
  68             throw new RestconfDocumentedException(Status.SERVICE_UNAVAILABLE);
  69         }
  70     }
  71
  72     // READ configuration
  73     public NormalizedNode<?, ?> readConfigurationData(final YangInstanceIdentifier path) {
  74         checkPreconditions();
  75         return readDataViaTransaction(domDataBroker.newReadOnlyTransaction(), CONFIGURATION, path);
  76     }
  77
  78     public NormalizedNode<?, ?> readConfigurationData(final DOMMountPoint mountPoint, final YangInstanceIdentifier path) {
  79         final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
  80         if (domDataBrokerService.isPresent()) {
  81             return readDataViaTransaction(domDataBrokerService.get().newReadOnlyTransaction(), CONFIGURATION, path);
  82         }
  83         throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
  84     }
  85
  86     // READ operational
  87     public NormalizedNode<?, ?> readOperationalData(final YangInstanceIdentifier path) {
  88         checkPreconditions();
  89         return readDataViaTransaction(domDataBroker.newReadOnlyTransaction(), OPERATIONAL, path);
  90     }
  91
  92     public NormalizedNode<?, ?> readOperationalData(final DOMMountPoint mountPoint, final YangInstanceIdentifier path) {
  93         final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
  94         if (domDataBrokerService.isPresent()) {
  95             return readDataViaTransaction(domDataBrokerService.get().newReadOnlyTransaction(), OPERATIONAL, path);
  96         }
  97         throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
  98     }
  99
 100     // PUT configuration
 101     public CheckedFuture<Void, TransactionCommitFailedException> commitConfigurationDataPut(
 102             final YangInstanceIdentifier path, final NormalizedNode<?, ?> payload) {
 103         checkPreconditions();
 104         DataNormalizationOperation<?> rootOp = ControllerContext.getInstance().getRootOperation();
 105         return putDataViaTransaction(domDataBroker.newReadWriteTransaction(), CONFIGURATION, path, payload, rootOp);
 106     }
 107
 108     public CheckedFuture<Void, TransactionCommitFailedException> commitConfigurationDataPut(
 109             final DOMMountPoint mountPoint, final YangInstanceIdentifier path, final NormalizedNode<?, ?> payload) {
 110         final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
 111         if (domDataBrokerService.isPresent()) {
 112             DataNormalizationOperation<?> rootOp = new DataNormalizer(mountPoint.getSchemaContext()).getRootOperation();
 113             return putDataViaTransaction(domDataBrokerService.get().newReadWriteTransaction(), CONFIGURATION, path,
 114                     payload, rootOp);
 115         }
 116         throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
 117     }
 118
 119     // POST configuration
 120     public CheckedFuture<Void, TransactionCommitFailedException> commitConfigurationDataPost(
 121             final YangInstanceIdentifier path, final NormalizedNode<?, ?> payload) {
 122         checkPreconditions();
 123         DataNormalizationOperation<?> rootOp = ControllerContext.getInstance().getRootOperation();
 124         return postDataViaTransaction(domDataBroker.newReadWriteTransaction(), CONFIGURATION, path, payload, rootOp);
 125     }
 126
 127     public CheckedFuture<Void, TransactionCommitFailedException> commitConfigurationDataPost(
 128             final DOMMountPoint mountPoint, final YangInstanceIdentifier path, final NormalizedNode<?, ?> payload) {
 129         final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
 130         if (domDataBrokerService.isPresent()) {
 131             DataNormalizationOperation<?> rootOp = new DataNormalizer(mountPoint.getSchemaContext()).getRootOperation();
 132             return postDataViaTransaction(domDataBrokerService.get().newReadWriteTransaction(), CONFIGURATION, path,
 133                     payload, rootOp);
 134         }
 135         throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
 136     }
 137
 138     // DELETE configuration
 139     public CheckedFuture<Void, TransactionCommitFailedException> commitConfigurationDataDelete(
 140             final YangInstanceIdentifier path) {
 141         checkPreconditions();
 142         return deleteDataViaTransaction(domDataBroker.newWriteOnlyTransaction(), CONFIGURATION, path);
 143     }
 144
 145     public CheckedFuture<Void, TransactionCommitFailedException> commitConfigurationDataDelete(
 146             final DOMMountPoint mountPoint, final YangInstanceIdentifier path) {
 147         final Optional<DOMDataBroker> domDataBrokerService = mountPoint.getService(DOMDataBroker.class);
 148         if (domDataBrokerService.isPresent()) {
 149             return deleteDataViaTransaction(domDataBrokerService.get().newWriteOnlyTransaction(), CONFIGURATION, path);
 150         }
 151         throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
 152     }
 153
 154     // RPC
 155     public Future<RpcResult<CompositeNode>> invokeRpc(final QName type, final CompositeNode payload) {
 156         this.checkPreconditions();
 157
 158         return context.rpc(type, payload);
 159     }
 160
 161     public void registerToListenDataChanges(final LogicalDatastoreType datastore, final DataChangeScope scope,
 162             final ListenerAdapter listener) {
 163         this.checkPreconditions();
 164
 165         if (listener.isListening()) {
 166             return;
 167         }
 168
 169         YangInstanceIdentifier path = listener.getPath();
 170         final ListenerRegistration<DOMDataChangeListener> registration = domDataBroker.registerDataChangeListener(
 171                 datastore, path, listener, scope);
 172
 173         listener.setRegistration(registration);
 174     }
 175
 176     private NormalizedNode<?, ?> readDataViaTransaction(final DOMDataReadTransaction transaction,
 177             LogicalDatastoreType datastore, YangInstanceIdentifier path) {
 178         LOG.trace("Read " + datastore.name() + " via Restconf: {}", path);
 179         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> listenableFuture =
 180                                                                  transaction.read(datastore, path);
 181
 182         try {
 183             Optional<NormalizedNode<?, ?>> optional = listenableFuture.checkedGet();
 184             return optional.isPresent() ? optional.get() : null;
 185         } catch(ReadFailedException e) {
 186             throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
 187         }
 188     }
 189
 190     private CheckedFuture<Void, TransactionCommitFailedException> postDataViaTransaction(
 191             final DOMDataReadWriteTransaction rWTransaction, final LogicalDatastoreType datastore,
 192             final YangInstanceIdentifier path, final NormalizedNode<?, ?> payload, DataNormalizationOperation<?> root) {
 193         CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> futureDatastoreData =
 194                                                                rWTransaction.read(datastore, path);
 195         try {
 196             final Optional<NormalizedNode<?, ?>> optionalDatastoreData = futureDatastoreData.checkedGet();
 197             if (optionalDatastoreData.isPresent() && payload.equals(optionalDatastoreData.get())) {
 198                 LOG.trace("Post Configuration via Restconf was not executed because data already exists :{}", path);
 199                 throw new RestconfDocumentedException("Data already exists for path: " + path, ErrorType.PROTOCOL,
 200                         ErrorTag.DATA_EXISTS);
 201             }
 202         } catch(ReadFailedException e) {
 203             LOG.warn("Error reading from datastore with path: " + path, e);
 204         }
 205
 206         ensureParentsByMerge(datastore, path, rWTransaction, root);
 207         rWTransaction.merge(datastore, path, payload);
 208         LOG.trace("Post " + datastore.name() + " via Restconf: {}", path);
 209         return rWTransaction.submit();
 210     }
 211
 212     private CheckedFuture<Void, TransactionCommitFailedException> putDataViaTransaction(
 213             final DOMDataReadWriteTransaction writeTransaction, final LogicalDatastoreType datastore,
 214             final YangInstanceIdentifier path, final NormalizedNode<?, ?> payload, DataNormalizationOperation<?> root) {
 215         LOG.trace("Put " + datastore.name() + " via Restconf: {}", path);
 216         ensureParentsByMerge(datastore, path, writeTransaction, root);
 217         writeTransaction.put(datastore, path, payload);
 218         return writeTransaction.submit();
 219     }
 220
 221     private CheckedFuture<Void, TransactionCommitFailedException> deleteDataViaTransaction(
 222             final DOMDataWriteTransaction writeTransaction, final LogicalDatastoreType datastore,
 223             YangInstanceIdentifier path) {
 224         LOG.info("Delete " + datastore.name() + " via Restconf: {}", path);
 225         writeTransaction.delete(datastore, path);
 226         return writeTransaction.submit();
 227     }
 228
 229     public void setDomDataBroker(DOMDataBroker domDataBroker) {
 230         this.domDataBroker = domDataBroker;
 231     }
 232
 233     private final void ensureParentsByMerge(final LogicalDatastoreType store,
 234             final YangInstanceIdentifier normalizedPath, final DOMDataReadWriteTransaction rwTx,
 235             final DataNormalizationOperation<?> root) {
 236         List<PathArgument> currentArguments = new ArrayList<>();
 237         Iterator<PathArgument> iterator = normalizedPath.getPathArguments().iterator();
 238         DataNormalizationOperation<?> currentOp = root;
 239         while (iterator.hasNext()) {
 240             PathArgument currentArg = iterator.next();
 241             try {
 242                 currentOp = currentOp.getChild(currentArg);
 243             } catch (DataNormalizationException e) {
 244                 throw new RestconfDocumentedException(
 245                         String.format("Error normalizing data for path %s", normalizedPath), e);
 246             }
 247             currentArguments.add(currentArg);
 248             YangInstanceIdentifier currentPath = YangInstanceIdentifier.create(currentArguments);
 249
 250             try {
 251
 252                 boolean exists = rwTx.exists(store, currentPath).checkedGet();
 253                 if (!exists && iterator.hasNext()) {
 254                     rwTx.merge(store, currentPath, currentOp.createDefault(currentArg));
 255                 }
 256             } catch (ReadFailedException e) {
 257                 LOG.error("Failed to read pre-existing data from store {} path {}", store, currentPath, e);
 258                 throw new RestconfDocumentedException("Failed to read pre-existing data", e);
 259             }
 260         }
 261     }
 262 }