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.md.sal.dom.broker.impl.compat;
10 import static com.google.common.base.Preconditions.checkNotNull;
12 import java.util.ArrayList;
13 import java.util.Collections;
14 import java.util.Iterator;
15 import java.util.List;
17 import java.util.Map.Entry;
19 import java.util.concurrent.ExecutionException;
20 import java.util.concurrent.Future;
22 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
24 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
25 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation;
26 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
27 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
29 import org.opendaylight.controller.sal.core.api.data.DataModificationTransaction;
30 import org.opendaylight.yangtools.concepts.Delegator;
31 import org.opendaylight.yangtools.concepts.ListenerRegistration;
32 import org.opendaylight.yangtools.yang.common.RpcResult;
33 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
34 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
40 import com.google.common.base.Optional;
41 import com.google.common.base.Preconditions;
42 import com.google.common.util.concurrent.ListenableFuture;
44 public abstract class BackwardsCompatibleTransaction<T extends DOMDataReadTransaction> implements
45 DataModificationTransaction, Delegator<T> {
47 private static final Logger LOG = LoggerFactory.getLogger(BackwardsCompatibleTransaction.class);
49 private final T asyncTx;
50 private final DataNormalizer normalizer;
52 protected BackwardsCompatibleTransaction(final T asyncTx, final DataNormalizer normalizer) {
54 this.asyncTx = asyncTx;
55 this.normalizer = normalizer;
58 public static BackwardsCompatibleTransaction<?> readOnlyTransaction(final DOMDataReadTransaction readTx,
59 final DataNormalizer normalizer) {
61 return new BackwardsCompatibleTransaction<DOMDataReadTransaction>(readTx, normalizer) {
64 public TransactionStatus getStatus() {
65 return TransactionStatus.NEW;
69 public Future<RpcResult<TransactionStatus>> commit() {
70 getDelegate().close();
76 public static BackwardsCompatibleTransaction<?> readWriteTransaction(final DOMDataReadWriteTransaction rwTx,
77 final DataNormalizer normalizer) {
78 return new ReadWriteTransaction(rwTx, normalizer);
81 protected DataNormalizer getNormalizer() {
86 public T getDelegate() {
91 public CompositeNode readConfigurationData(final InstanceIdentifier legacyPath) {
93 InstanceIdentifier normalizedPath = normalizer.toNormalized(legacyPath);
95 ListenableFuture<Optional<NormalizedNode<?, ?>>> normalizedData = asyncTx.read(
96 LogicalDatastoreType.CONFIGURATION, normalizedPath);
99 return normalizer.toLegacy(normalizedPath, normalizedData.get().orNull());
100 } catch (InterruptedException | ExecutionException e) {
106 public CompositeNode readOperationalData(final InstanceIdentifier legacyPath) {
107 InstanceIdentifier normalizedPath = normalizer.toNormalized(legacyPath);
109 ListenableFuture<Optional<NormalizedNode<?, ?>>> normalizedData = asyncTx.read(
110 LogicalDatastoreType.OPERATIONAL, normalizedPath);
113 return normalizer.toLegacy(normalizedPath, normalizedData.get().orNull());
114 } catch (InterruptedException | ExecutionException e) {
120 public ListenerRegistration<DataTransactionListener> registerListener(final DataTransactionListener listener) {
121 throw new UnsupportedOperationException();
125 public Map<InstanceIdentifier, CompositeNode> getCreatedConfigurationData() {
126 return Collections.emptyMap();
130 public Map<InstanceIdentifier, CompositeNode> getCreatedOperationalData() {
131 return Collections.emptyMap();
135 public Map<InstanceIdentifier, CompositeNode> getOriginalConfigurationData() {
136 return Collections.emptyMap();
140 public Map<InstanceIdentifier, CompositeNode> getOriginalOperationalData() {
141 return Collections.emptyMap();
145 public Set<InstanceIdentifier> getRemovedConfigurationData() {
146 return Collections.emptySet();
150 public Set<InstanceIdentifier> getRemovedOperationalData() {
151 return Collections.emptySet();
155 public Map<InstanceIdentifier, CompositeNode> getUpdatedConfigurationData() {
156 return Collections.emptyMap();
160 public Map<InstanceIdentifier, CompositeNode> getUpdatedOperationalData() {
161 return Collections.emptyMap();
165 public void putConfigurationData(final InstanceIdentifier path, final CompositeNode data) {
166 throw new UnsupportedOperationException();
170 public void putOperationalData(final InstanceIdentifier path, final CompositeNode data) {
171 throw new UnsupportedOperationException();
175 public void removeConfigurationData(final InstanceIdentifier path) {
176 throw new UnsupportedOperationException();
180 public void removeOperationalData(final InstanceIdentifier path) {
181 throw new UnsupportedOperationException();
185 public Object getIdentifier() {
186 return asyncTx.getIdentifier();
189 private static final class ReadWriteTransaction extends BackwardsCompatibleTransaction<DOMDataReadWriteTransaction> {
191 private TransactionStatus status = TransactionStatus.NEW;
193 protected ReadWriteTransaction(final DOMDataReadWriteTransaction asyncTx, final DataNormalizer normalizer) {
194 super(asyncTx, normalizer);
198 public TransactionStatus getStatus() {
203 public Future<RpcResult<TransactionStatus>> commit() {
204 Preconditions.checkState(status == TransactionStatus.NEW);
205 status = TransactionStatus.SUBMITED;
206 return getDelegate().commit();
210 public void putConfigurationData(final InstanceIdentifier legacyPath, final CompositeNode legacyData) {
211 checkNotNull(legacyPath, "Path MUST NOT be null.");
212 checkNotNull(legacyData, "Data for path %s MUST NOT be null",legacyData);
213 Entry<InstanceIdentifier, NormalizedNode<?, ?>> normalizedData = getNormalizer().toNormalized(legacyPath, legacyData);
214 putWithEnsuredParents(LogicalDatastoreType.CONFIGURATION, normalizedData.getKey(), normalizedData.getValue());
218 public void putOperationalData(final InstanceIdentifier legacyPath, final CompositeNode legacyData) {
219 checkNotNull(legacyPath, "Path MUST NOT be null.");
220 checkNotNull(legacyData, "Data for path %s MUST NOT be null",legacyData);
221 Entry<InstanceIdentifier, NormalizedNode<?, ?>> normalizedData = getNormalizer().toNormalized(legacyPath, legacyData);
222 putWithEnsuredParents(LogicalDatastoreType.OPERATIONAL, normalizedData.getKey(), normalizedData.getValue());
225 private void putWithEnsuredParents(final LogicalDatastoreType store, final InstanceIdentifier normalizedPath,
226 final NormalizedNode<?, ?> normalizedData) {
228 LOG.trace("write {}:{} ",store,normalizedPath);
230 List<PathArgument> currentArguments = new ArrayList<>();
231 DataNormalizationOperation<?> currentOp = getNormalizer().getRootOperation();
232 Iterator<PathArgument> iterator = normalizedPath.getPath().iterator();
233 while(iterator.hasNext()) {
234 PathArgument currentArg = iterator.next();
236 currentOp = currentOp.getChild(currentArg);
237 } catch (DataNormalizationException e) {
238 throw new IllegalArgumentException(String.format("Invalid child encountered in path %s", normalizedPath), e);
240 currentArguments.add(currentArg);
241 InstanceIdentifier currentPath = new InstanceIdentifier(currentArguments);
242 boolean isPresent = getDelegate().read(store, currentPath).get().isPresent();
243 if(isPresent == false && iterator.hasNext()) {
244 getDelegate().merge(store, currentPath, currentOp.createDefault(currentArg));
247 } catch (InterruptedException | ExecutionException e) {
248 LOG.error("Exception durring read.",e);
251 getDelegate().put(store, normalizedPath, normalizedData);
255 public void removeConfigurationData(final InstanceIdentifier legacyPath) {
256 checkNotNull(legacyPath, "Path MUST NOT be null.");
257 getDelegate().delete(LogicalDatastoreType.CONFIGURATION, getNormalizer().toNormalized(legacyPath));
261 public void removeOperationalData(final InstanceIdentifier legacyPath) {
262 checkNotNull(legacyPath, "Path MUST NOT be null.");
263 getDelegate().delete(LogicalDatastoreType.OPERATIONAL, getNormalizer().toNormalized(legacyPath));