2 * Copyright (c) 2017 Inocybe Technologies 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.core.compat;
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ClassToInstanceMap;
13 import com.google.common.collect.ForwardingObject;
14 import com.google.common.collect.ImmutableClassToInstanceMap;
15 import com.google.common.collect.ImmutableClassToInstanceMap.Builder;
16 import com.google.common.util.concurrent.CheckedFuture;
17 import com.google.common.util.concurrent.FluentFuture;
18 import com.google.common.util.concurrent.FutureCallback;
19 import com.google.common.util.concurrent.MoreExecutors;
20 import com.google.common.util.concurrent.SettableFuture;
22 import java.util.concurrent.atomic.AtomicReference;
23 import javax.annotation.Nonnull;
24 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
25 import org.opendaylight.controller.md.sal.common.api.data.DataStoreUnavailableException;
26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
27 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
28 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
29 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
30 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
31 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
32 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
33 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
34 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
35 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
36 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
37 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
38 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeCommitCohortRegistry;
39 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
40 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
41 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
42 import org.opendaylight.mdsal.common.api.CommitInfo;
43 import org.opendaylight.mdsal.common.api.MappingCheckedFuture;
44 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort;
45 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration;
46 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
47 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
48 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
49 import org.opendaylight.yangtools.concepts.ListenerRegistration;
50 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
52 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
55 * Adapter between the legacy controller API-based DOMDataBroker and the mdsal API-based DOMDataBroker.
57 * @author Thomas Pantelis
59 public class LegacyDOMDataBrokerAdapter extends ForwardingObject implements DOMDataBroker {
60 private static final ExceptionMapper<TransactionCommitFailedException> COMMIT_EX_MAPPER =
61 new ExceptionMapper<TransactionCommitFailedException>("commit", TransactionCommitFailedException.class) {
63 protected TransactionCommitFailedException newWithCause(String message, Throwable cause) {
64 if (cause instanceof org.opendaylight.mdsal.common.api.OptimisticLockFailedException) {
65 return new OptimisticLockFailedException(cause.getMessage(), cause.getCause());
66 } else if (cause instanceof org.opendaylight.mdsal.common.api.TransactionCommitFailedException) {
67 Throwable rootCause = cause.getCause();
68 if (rootCause instanceof org.opendaylight.mdsal.common.api.DataStoreUnavailableException) {
69 rootCause = new DataStoreUnavailableException(rootCause.getMessage(), rootCause.getCause());
72 return new TransactionCommitFailedException(cause.getMessage(), rootCause);
75 return new TransactionCommitFailedException(message, cause);
79 private final org.opendaylight.mdsal.dom.api.DOMDataBroker delegate;
80 private final ClassToInstanceMap<DOMDataBrokerExtension> extensions;
82 public LegacyDOMDataBrokerAdapter(org.opendaylight.mdsal.dom.api.DOMDataBroker delegate) {
83 this.delegate = delegate;
85 ClassToInstanceMap<org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension> delegateExtensions =
86 delegate.getExtensions();
88 Builder<DOMDataBrokerExtension> extBuilder = ImmutableClassToInstanceMap.builder();
89 final org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService delegateTreeChangeService =
90 (org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService) delegateExtensions.get(
91 org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService.class);
92 if (delegateTreeChangeService != null) {
93 extBuilder.put(DOMDataTreeChangeService.class, new DOMDataTreeChangeService() {
95 public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerDataTreeChangeListener(
96 DOMDataTreeIdentifier treeId, final L listener) {
97 final org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener delegateListener;
98 if (listener instanceof ClusteredDOMDataTreeChangeListener) {
99 delegateListener = (org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener)
100 changes -> listener.onDataTreeChanged(changes);
102 delegateListener = changes -> listener.onDataTreeChanged(changes);
105 final ListenerRegistration<org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener> reg =
106 delegateTreeChangeService.registerDataTreeChangeListener(
107 new org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier(convert(treeId.getDatastoreType()),
108 treeId.getRootIdentifier()), delegateListener);
110 return new ListenerRegistration<L>() {
112 public L getInstance() {
117 public void close() {
125 final org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry delegateCohortRegistry =
126 (org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry) delegateExtensions.get(
127 org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry.class);
128 if (delegateCohortRegistry != null) {
129 extBuilder.put(DOMDataTreeCommitCohortRegistry.class, new DOMDataTreeCommitCohortRegistry() {
131 public <T extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<T> registerCommitCohort(
132 org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier path, T cohort) {
133 return delegateCohortRegistry.registerCommitCohort(path, cohort);
138 extensions = extBuilder.build();
142 protected org.opendaylight.mdsal.dom.api.DOMDataBroker delegate() {
147 public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
152 public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
153 return new DOMDataReadOnlyTransactionAdapter(delegate().newReadOnlyTransaction());
157 public DOMDataReadWriteTransaction newReadWriteTransaction() {
158 return new DOMDataTransactionAdapter(delegate().newReadWriteTransaction());
162 public DOMDataWriteTransaction newWriteOnlyTransaction() {
163 return new DOMDataTransactionAdapter(delegate().newWriteOnlyTransaction());
167 public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
168 AtomicReference<DOMTransactionChain> legacyChain = new AtomicReference<>();
169 org.opendaylight.mdsal.common.api.TransactionChainListener delegateListener =
170 new org.opendaylight.mdsal.common.api.TransactionChainListener() {
171 @SuppressWarnings("rawtypes")
173 public void onTransactionChainFailed(final org.opendaylight.mdsal.common.api.TransactionChain<?, ?> chain,
174 final org.opendaylight.mdsal.common.api.AsyncTransaction<?, ?> transaction, final Throwable cause) {
175 listener.onTransactionChainFailed(legacyChain.get(),
176 (AsyncTransaction) () -> transaction.getIdentifier(),
177 cause instanceof Exception ? COMMIT_EX_MAPPER.apply((Exception)cause) : cause);
181 public void onTransactionChainSuccessful(org.opendaylight.mdsal.common.api.TransactionChain<?, ?> chain) {
182 listener.onTransactionChainSuccessful(legacyChain.get());
186 final org.opendaylight.mdsal.dom.api.DOMTransactionChain delegateChain =
187 delegate().createTransactionChain(delegateListener);
188 legacyChain.set(new DOMTransactionChain() {
190 public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
191 return new DOMDataReadOnlyTransactionAdapter(delegateChain.newReadOnlyTransaction());
195 public DOMDataReadWriteTransaction newReadWriteTransaction() {
196 return new DOMDataTransactionAdapter(delegateChain.newReadWriteTransaction());
200 public DOMDataWriteTransaction newWriteOnlyTransaction() {
201 return new DOMDataTransactionAdapter(delegateChain.newWriteOnlyTransaction());
205 public void close() {
206 delegateChain.close();
210 return legacyChain.get();
213 private static org.opendaylight.mdsal.common.api.LogicalDatastoreType convert(LogicalDatastoreType datastoreType) {
214 return org.opendaylight.mdsal.common.api.LogicalDatastoreType.valueOf(datastoreType.name());
217 private static class DOMDataTransactionAdapter implements DOMDataReadWriteTransaction {
218 private final DOMDataTreeReadTransaction readDelegate;
219 private final DOMDataTreeWriteTransaction writeDelegate;
220 private final Object identifier;
222 DOMDataTransactionAdapter(@Nonnull DOMDataTreeReadTransaction readDelegate) {
223 this.readDelegate = Preconditions.checkNotNull(readDelegate);
224 this.identifier = readDelegate.getIdentifier();
225 this.writeDelegate = null;
228 DOMDataTransactionAdapter(@Nonnull DOMDataTreeWriteTransaction writeDelegate) {
229 this.writeDelegate = Preconditions.checkNotNull(writeDelegate);
230 this.identifier = writeDelegate.getIdentifier();
231 this.readDelegate = null;
234 DOMDataTransactionAdapter(@Nonnull DOMDataTreeReadWriteTransaction rwDelegate) {
235 this.readDelegate = Preconditions.checkNotNull(rwDelegate);
236 this.writeDelegate = rwDelegate;
237 this.identifier = readDelegate.getIdentifier();
240 DOMDataTreeReadTransaction readDelegate() {
244 DOMDataTreeWriteTransaction writeDelegate() {
245 return writeDelegate;
249 public Object getIdentifier() {
254 public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(LogicalDatastoreType store,
255 YangInstanceIdentifier path) {
256 return MappingCheckedFuture.create(readDelegate().read(convert(store), path),
257 ReadFailedExceptionAdapter.INSTANCE);
261 public CheckedFuture<Boolean, ReadFailedException> exists(LogicalDatastoreType store,
262 YangInstanceIdentifier path) {
263 return MappingCheckedFuture.create(readDelegate().exists(convert(store), path),
264 ReadFailedExceptionAdapter.INSTANCE);
268 public void delete(LogicalDatastoreType store, YangInstanceIdentifier path) {
269 writeDelegate().delete(convert(store), path);
273 public void put(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data) {
274 writeDelegate().put(convert(store), path, data);
278 public void merge(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data) {
279 writeDelegate().merge(convert(store), path, data);
283 public boolean cancel() {
284 return writeDelegate().cancel();
288 public FluentFuture<? extends CommitInfo> commit() {
289 final SettableFuture<CommitInfo> resultFuture = SettableFuture.create();
290 writeDelegate().commit().addCallback(new FutureCallback<CommitInfo>() {
292 public void onSuccess(CommitInfo result) {
293 resultFuture.set(result);
297 public void onFailure(Throwable ex) {
298 if (ex instanceof Exception) {
299 resultFuture.setException(COMMIT_EX_MAPPER.apply((Exception)ex));
301 resultFuture.setException(ex);
304 }, MoreExecutors.directExecutor());
310 private static class DOMDataReadOnlyTransactionAdapter implements DOMDataReadOnlyTransaction {
311 private final DOMDataTransactionAdapter adapter;
313 DOMDataReadOnlyTransactionAdapter(DOMDataTreeReadTransaction delegateTx) {
314 adapter = new DOMDataTransactionAdapter(delegateTx);
318 public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(LogicalDatastoreType store,
319 YangInstanceIdentifier path) {
320 return adapter.read(store, path);
324 public CheckedFuture<Boolean, ReadFailedException> exists(LogicalDatastoreType store,
325 YangInstanceIdentifier path) {
326 return adapter.exists(store, path);
330 public Object getIdentifier() {
331 return adapter.getIdentifier();
335 public void close() {
336 adapter.readDelegate().close();