2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.sal.restconf.impl;
10 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.CONFIGURATION;
11 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.OPERATIONAL;
13 import com.google.common.base.Optional;
14 import com.google.common.util.concurrent.CheckedFuture;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import java.util.ArrayList;
17 import java.util.Iterator;
18 import java.util.List;
19 import java.util.concurrent.ExecutionException;
20 import java.util.concurrent.Future;
21 import javax.ws.rs.core.Response.Status;
22 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
24 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
25 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
26 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation;
27 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
29 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
30 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction;
31 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
32 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
33 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
34 import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
35 import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorTag;
36 import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorType;
37 import org.opendaylight.controller.sal.streams.listeners.ListenerAdapter;
38 import org.opendaylight.yangtools.concepts.ListenerRegistration;
39 import org.opendaylight.yangtools.yang.common.QName;
40 import org.opendaylight.yangtools.yang.common.RpcResult;
41 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
48 public class BrokerFacade {
49 private final static Logger LOG = LoggerFactory.getLogger(BrokerFacade.class);
51 private final static BrokerFacade INSTANCE = new BrokerFacade();
52 private volatile ConsumerSession context;
53 private DOMDataBroker domDataBroker;
55 private BrokerFacade() {
58 public void setContext(final ConsumerSession context) {
59 this.context = context;
62 public static BrokerFacade getInstance() {
63 return BrokerFacade.INSTANCE;
66 private void checkPreconditions() {
67 if (context == null || domDataBroker == null) {
68 throw new RestconfDocumentedException(Status.SERVICE_UNAVAILABLE);
73 public NormalizedNode<?, ?> readConfigurationData(final YangInstanceIdentifier path) {
75 return readDataViaTransaction(domDataBroker.newReadOnlyTransaction(), CONFIGURATION, path);
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);
83 throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
87 public NormalizedNode<?, ?> readOperationalData(final YangInstanceIdentifier path) {
89 return readDataViaTransaction(domDataBroker.newReadOnlyTransaction(), OPERATIONAL, path);
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);
97 throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
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);
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,
116 throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
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);
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,
135 throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
138 // DELETE configuration
139 public CheckedFuture<Void, TransactionCommitFailedException> commitConfigurationDataDelete(
140 final YangInstanceIdentifier path) {
141 checkPreconditions();
142 return deleteDataViaTransaction(domDataBroker.newWriteOnlyTransaction(), CONFIGURATION, path);
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);
151 throw new RestconfDocumentedException("DOM data broker service isn't available for mount point.");
155 public Future<RpcResult<CompositeNode>> invokeRpc(final QName type, final CompositeNode payload) {
156 this.checkPreconditions();
158 return context.rpc(type, payload);
161 public void registerToListenDataChanges(final LogicalDatastoreType datastore, final DataChangeScope scope,
162 final ListenerAdapter listener) {
163 this.checkPreconditions();
165 if (listener.isListening()) {
169 YangInstanceIdentifier path = listener.getPath();
170 final ListenerRegistration<DOMDataChangeListener> registration = domDataBroker.registerDataChangeListener(
171 datastore, path, listener, scope);
173 listener.setRegistration(registration);
176 private NormalizedNode<?, ?> readDataViaTransaction(final DOMDataReadTransaction transaction,
177 LogicalDatastoreType datastore, YangInstanceIdentifier path) {
178 LOG.trace("Read " + datastore.name() + " via Restconf: {}", path);
179 final ListenableFuture<Optional<NormalizedNode<?, ?>>> listenableFuture = transaction.read(datastore, path);
180 if (listenableFuture != null) {
181 Optional<NormalizedNode<?, ?>> optional;
183 LOG.debug("Reading result data from transaction.");
184 optional = listenableFuture.get();
185 } catch (InterruptedException | ExecutionException e) {
186 throw new RestconfDocumentedException("Problem to get data from transaction.", e.getCause());
189 if (optional != null) {
190 if (optional.isPresent()) {
191 return optional.get();
198 private CheckedFuture<Void, TransactionCommitFailedException> postDataViaTransaction(
199 final DOMDataReadWriteTransaction rWTransaction, final LogicalDatastoreType datastore,
200 final YangInstanceIdentifier path, final NormalizedNode<?, ?> payload, DataNormalizationOperation<?> root) {
201 ListenableFuture<Optional<NormalizedNode<?, ?>>> futureDatastoreData = rWTransaction.read(datastore, path);
203 final Optional<NormalizedNode<?, ?>> optionalDatastoreData = futureDatastoreData.get();
204 if (optionalDatastoreData.isPresent() && payload.equals(optionalDatastoreData.get())) {
205 String errMsg = "Post Configuration via Restconf was not executed because data already exists";
206 LOG.trace(errMsg + ":{}", path);
207 throw new RestconfDocumentedException("Data already exists for path: " + path, ErrorType.PROTOCOL,
208 ErrorTag.DATA_EXISTS);
210 } catch (InterruptedException | ExecutionException e) {
211 LOG.trace("It wasn't possible to get data loaded from datastore at path " + path);
214 ensureParentsByMerge(datastore, path, rWTransaction, root);
215 rWTransaction.merge(datastore, path, payload);
216 LOG.trace("Post " + datastore.name() + " via Restconf: {}", path);
217 return rWTransaction.submit();
220 private CheckedFuture<Void, TransactionCommitFailedException> putDataViaTransaction(
221 final DOMDataReadWriteTransaction writeTransaction, final LogicalDatastoreType datastore,
222 final YangInstanceIdentifier path, final NormalizedNode<?, ?> payload, DataNormalizationOperation<?> root) {
223 LOG.trace("Put " + datastore.name() + " via Restconf: {}", path);
224 ensureParentsByMerge(datastore, path, writeTransaction, root);
225 writeTransaction.put(datastore, path, payload);
226 return writeTransaction.submit();
229 private CheckedFuture<Void, TransactionCommitFailedException> deleteDataViaTransaction(
230 final DOMDataWriteTransaction writeTransaction, final LogicalDatastoreType datastore,
231 YangInstanceIdentifier path) {
232 LOG.info("Delete " + datastore.name() + " via Restconf: {}", path);
233 writeTransaction.delete(datastore, path);
234 return writeTransaction.submit();
237 public void setDomDataBroker(DOMDataBroker domDataBroker) {
238 this.domDataBroker = domDataBroker;
241 private final void ensureParentsByMerge(final LogicalDatastoreType store,
242 final YangInstanceIdentifier normalizedPath, final DOMDataReadWriteTransaction rwTx,
243 final DataNormalizationOperation<?> root) {
244 List<PathArgument> currentArguments = new ArrayList<>();
245 Iterator<PathArgument> iterator = normalizedPath.getPathArguments().iterator();
246 DataNormalizationOperation<?> currentOp = root;
247 while (iterator.hasNext()) {
248 PathArgument currentArg = iterator.next();
250 currentOp = currentOp.getChild(currentArg);
251 } catch (DataNormalizationException e) {
252 throw new IllegalArgumentException(
253 String.format("Invalid child encountered in path %s", normalizedPath), e);
255 currentArguments.add(currentArg);
256 YangInstanceIdentifier currentPath = YangInstanceIdentifier.create(currentArguments);
258 final Optional<NormalizedNode<?, ?>> datastoreData;
260 datastoreData = rwTx.read(store, currentPath).get();
261 } catch (InterruptedException | ExecutionException e) {
262 LOG.error("Failed to read pre-existing data from store {} path {}", store, currentPath, e);
263 throw new IllegalStateException("Failed to read pre-existing data", e);
266 if (!datastoreData.isPresent() && iterator.hasNext()) {
267 rwTx.merge(store, currentPath, currentOp.createDefault(currentArg));