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.cluster.databroker.compat;
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ForwardingObject;
13 import com.google.common.collect.ImmutableMap;
14 import com.google.common.collect.ImmutableMap.Builder;
15 import com.google.common.util.concurrent.CheckedFuture;
16 import com.google.common.util.concurrent.FluentFuture;
17 import com.google.common.util.concurrent.FutureCallback;
18 import com.google.common.util.concurrent.MoreExecutors;
19 import com.google.common.util.concurrent.SettableFuture;
21 import java.util.concurrent.atomic.AtomicReference;
22 import javax.annotation.Nonnull;
23 import org.opendaylight.controller.cluster.databroker.AbstractDOMBroker;
24 import org.opendaylight.controller.cluster.datastore.compat.LegacyDOMStoreAdapter;
25 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
26 import org.opendaylight.controller.md.sal.common.api.data.DataStoreUnavailableException;
27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
28 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
29 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
30 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
31 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
32 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
33 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
34 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
35 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
36 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
37 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
38 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
39 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeCommitCohortRegistry;
40 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
41 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
42 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
43 import org.opendaylight.mdsal.common.api.CommitInfo;
44 import org.opendaylight.mdsal.common.api.MappingCheckedFuture;
45 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort;
46 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration;
47 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
48 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
49 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
50 import org.opendaylight.yangtools.concepts.ListenerRegistration;
51 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
53 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
56 * Adapter between the legacy controller API-based DOMDataBroker and the mdsal API-based DOMDataBroker.
58 * @author Thomas Pantelis
60 public class LegacyDOMDataBrokerAdapter extends ForwardingObject implements DOMDataBroker {
61 private static final ExceptionMapper<TransactionCommitFailedException> COMMIT_EX_MAPPER =
62 new ExceptionMapper<TransactionCommitFailedException>("commit", TransactionCommitFailedException.class) {
64 protected TransactionCommitFailedException newWithCause(String message, Throwable cause) {
65 if (cause instanceof org.opendaylight.mdsal.common.api.OptimisticLockFailedException) {
66 return new OptimisticLockFailedException(cause.getMessage(), cause.getCause());
67 } else if (cause instanceof org.opendaylight.mdsal.common.api.TransactionCommitFailedException) {
68 Throwable rootCause = cause.getCause();
69 if (rootCause instanceof org.opendaylight.mdsal.common.api.DataStoreUnavailableException) {
70 rootCause = new DataStoreUnavailableException(rootCause.getMessage(), rootCause.getCause());
73 return new TransactionCommitFailedException(cause.getMessage(), rootCause);
76 return new TransactionCommitFailedException(message, cause);
80 private final AbstractDOMBroker delegate;
81 private final Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> extensions;
83 public LegacyDOMDataBrokerAdapter(AbstractDOMBroker delegate) {
84 this.delegate = delegate;
86 Map<Class<? extends org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension>,
87 org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension> delegateExtensions =
88 delegate.getSupportedExtensions();
90 Builder<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> extBuilder = ImmutableMap.builder();
91 final org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService delegateTreeChangeService =
92 (org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService) delegateExtensions.get(
93 org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService.class);
94 if (delegateTreeChangeService != null) {
95 extBuilder.put(DOMDataTreeChangeService.class, new DOMDataTreeChangeService() {
97 public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerDataTreeChangeListener(
98 DOMDataTreeIdentifier treeId, final L listener) {
99 final org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener delegateListener;
100 if (listener instanceof ClusteredDOMDataTreeChangeListener) {
101 delegateListener = (org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener)
102 changes -> listener.onDataTreeChanged(changes);
104 delegateListener = changes -> listener.onDataTreeChanged(changes);
107 final ListenerRegistration<org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener> reg =
108 delegateTreeChangeService.registerDataTreeChangeListener(
109 new org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier(convert(treeId.getDatastoreType()),
110 treeId.getRootIdentifier()), delegateListener);
112 return new ListenerRegistration<L>() {
114 public L getInstance() {
119 public void close() {
127 final org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry delegateCohortRegistry =
128 (org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry) delegateExtensions.get(
129 org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry.class);
130 if (delegateCohortRegistry != null) {
131 extBuilder.put(DOMDataTreeCommitCohortRegistry.class, new DOMDataTreeCommitCohortRegistry() {
133 public <T extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<T> registerCommitCohort(
134 org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier path, T cohort) {
135 return delegateCohortRegistry.registerCommitCohort(path, cohort);
140 extensions = extBuilder.build();
144 protected AbstractDOMBroker delegate() {
149 public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
154 public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
155 return new DOMDataReadOnlyTransactionAdapter(delegate().newReadOnlyTransaction());
159 public DOMDataReadWriteTransaction newReadWriteTransaction() {
160 return new DOMDataTransactionAdapter(delegate().newReadWriteTransaction());
164 public DOMDataWriteTransaction newWriteOnlyTransaction() {
165 return new DOMDataTransactionAdapter(delegate().newWriteOnlyTransaction());
169 public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
170 AtomicReference<DOMTransactionChain> legacyChain = new AtomicReference<>();
171 org.opendaylight.mdsal.common.api.TransactionChainListener delegateListener =
172 new org.opendaylight.mdsal.common.api.TransactionChainListener() {
173 @SuppressWarnings("rawtypes")
175 public void onTransactionChainFailed(final org.opendaylight.mdsal.common.api.TransactionChain<?, ?> chain,
176 final org.opendaylight.mdsal.common.api.AsyncTransaction<?, ?> transaction, final Throwable cause) {
177 listener.onTransactionChainFailed(legacyChain.get(),
178 (AsyncTransaction) () -> transaction.getIdentifier(),
179 cause instanceof Exception ? COMMIT_EX_MAPPER.apply((Exception)cause) : cause);
183 public void onTransactionChainSuccessful(org.opendaylight.mdsal.common.api.TransactionChain<?, ?> chain) {
184 listener.onTransactionChainSuccessful(legacyChain.get());
188 final org.opendaylight.mdsal.dom.api.DOMTransactionChain delegateChain =
189 delegate().createTransactionChain(delegateListener);
190 legacyChain.set(new DOMTransactionChain() {
192 public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
193 return new DOMDataReadOnlyTransactionAdapter(delegateChain.newReadOnlyTransaction());
197 public DOMDataReadWriteTransaction newReadWriteTransaction() {
198 return new DOMDataTransactionAdapter(delegateChain.newReadWriteTransaction());
202 public DOMDataWriteTransaction newWriteOnlyTransaction() {
203 return new DOMDataTransactionAdapter(delegateChain.newWriteOnlyTransaction());
207 public void close() {
208 delegateChain.close();
212 return legacyChain.get();
215 private static org.opendaylight.mdsal.common.api.LogicalDatastoreType convert(LogicalDatastoreType datastoreType) {
216 return org.opendaylight.mdsal.common.api.LogicalDatastoreType.valueOf(datastoreType.name());
219 private static class DOMDataTransactionAdapter implements DOMDataReadWriteTransaction {
220 private final DOMDataTreeReadTransaction readDelegate;
221 private final DOMDataTreeWriteTransaction writeDelegate;
222 private final Object identifier;
224 DOMDataTransactionAdapter(@Nonnull DOMDataTreeReadTransaction readDelegate) {
225 this.readDelegate = Preconditions.checkNotNull(readDelegate);
226 this.identifier = readDelegate.getIdentifier();
227 this.writeDelegate = null;
230 DOMDataTransactionAdapter(@Nonnull DOMDataTreeWriteTransaction writeDelegate) {
231 this.writeDelegate = Preconditions.checkNotNull(writeDelegate);
232 this.identifier = writeDelegate.getIdentifier();
233 this.readDelegate = null;
236 DOMDataTransactionAdapter(@Nonnull DOMDataTreeReadWriteTransaction rwDelegate) {
237 this.readDelegate = Preconditions.checkNotNull(rwDelegate);
238 this.writeDelegate = rwDelegate;
239 this.identifier = readDelegate.getIdentifier();
242 DOMDataTreeReadTransaction readDelegate() {
246 DOMDataTreeWriteTransaction writeDelegate() {
247 return writeDelegate;
251 public Object getIdentifier() {
256 public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(LogicalDatastoreType store,
257 YangInstanceIdentifier path) {
258 return MappingCheckedFuture.create(readDelegate().read(convert(store), path),
259 LegacyDOMStoreAdapter.READ_EX_MAPPER);
263 public CheckedFuture<Boolean, ReadFailedException> exists(LogicalDatastoreType store,
264 YangInstanceIdentifier path) {
265 return MappingCheckedFuture.create(readDelegate().exists(convert(store), path),
266 LegacyDOMStoreAdapter.READ_EX_MAPPER);
270 public void delete(LogicalDatastoreType store, YangInstanceIdentifier path) {
271 writeDelegate().delete(convert(store), path);
275 public void put(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data) {
276 writeDelegate().put(convert(store), path, data);
280 public void merge(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data) {
281 writeDelegate().merge(convert(store), path, data);
285 public boolean cancel() {
286 return writeDelegate().cancel();
290 public FluentFuture<? extends CommitInfo> commit() {
291 final SettableFuture<CommitInfo> resultFuture = SettableFuture.create();
292 writeDelegate().commit().addCallback(new FutureCallback<CommitInfo>() {
294 public void onSuccess(CommitInfo result) {
295 resultFuture.set(result);
299 public void onFailure(Throwable ex) {
300 if (ex instanceof Exception) {
301 resultFuture.setException(COMMIT_EX_MAPPER.apply((Exception)ex));
303 resultFuture.setException(ex);
306 }, MoreExecutors.directExecutor());
312 private static class DOMDataReadOnlyTransactionAdapter implements DOMDataReadOnlyTransaction {
313 private final DOMDataTransactionAdapter adapter;
315 DOMDataReadOnlyTransactionAdapter(DOMDataTreeReadTransaction delegateTx) {
316 adapter = new DOMDataTransactionAdapter(delegateTx);
320 public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(LogicalDatastoreType store,
321 YangInstanceIdentifier path) {
322 return adapter.read(store, path);
326 public CheckedFuture<Boolean, ReadFailedException> exists(LogicalDatastoreType store,
327 YangInstanceIdentifier path) {
328 return adapter.exists(store, path);
332 public Object getIdentifier() {
333 return adapter.getIdentifier();
337 public void close() {
338 adapter.readDelegate().close();