opendaylight/md-sal/sal-dom-compat/src/main/java/org/opendaylight/controller/sal/core/compat/LegacyDOMDataBrokerAdapter.java

   1 /*
   2  * Copyright (c) 2017 Inocybe Technologies 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.core.compat;
   9
  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;
  21 import java.util.Map;
  22 import java.util.concurrent.atomic.AtomicReference;
  23 import java.util.function.Supplier;
  24 import javax.annotation.Nonnull;
  25 import org.opendaylight.controller.md.sal.common.api.MappingCheckedFuture;
  26 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  27 import org.opendaylight.controller.md.sal.common.api.data.DataStoreUnavailableException;
  28 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  29 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
  30 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  31 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainClosedException;
  32 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  33 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  34 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
  35 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  36 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
  37 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  38 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  39 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
  40 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  41 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeCommitCohortRegistry;
  42 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
  43 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  44 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  45 import org.opendaylight.mdsal.common.api.CommitInfo;
  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;
  53
  54 /**
  55  * Adapter between the legacy controller API-based DOMDataBroker and the mdsal API-based DOMDataBroker.
  56  *
  57  * @author Thomas Pantelis
  58  */
  59 public class LegacyDOMDataBrokerAdapter extends ForwardingObject implements DOMDataBroker {
  60     private static final ExceptionMapper<TransactionCommitFailedException> COMMIT_EX_MAPPER =
  61             new ExceptionMapper<TransactionCommitFailedException>("commit", TransactionCommitFailedException.class) {
  62         @Override
  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());
  70                 }
  71
  72                 return new TransactionCommitFailedException(cause.getMessage(), rootCause);
  73             }
  74
  75             return new TransactionCommitFailedException(message, cause);
  76         }
  77     };
  78
  79     private final org.opendaylight.mdsal.dom.api.DOMDataBroker delegate;
  80     private final ClassToInstanceMap<DOMDataBrokerExtension> extensions;
  81
  82     public LegacyDOMDataBrokerAdapter(org.opendaylight.mdsal.dom.api.DOMDataBroker delegate) {
  83         this.delegate = delegate;
  84
  85         ClassToInstanceMap<org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension> delegateExtensions =
  86                 delegate.getExtensions();
  87
  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() {
  94                 @Override
  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                             listener::onDataTreeChanged;
 101                     } else {
 102                         delegateListener = listener::onDataTreeChanged;
 103                     }
 104
 105                     final ListenerRegistration<org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener> reg =
 106                         delegateTreeChangeService.registerDataTreeChangeListener(treeId.toMdsal(), delegateListener);
 107
 108                     return new ListenerRegistration<L>() {
 109                         @Override
 110                         public L getInstance() {
 111                             return listener;
 112                         }
 113
 114                         @Override
 115                         public void close() {
 116                             reg.close();
 117                         }
 118                     };
 119                 }
 120             });
 121         }
 122
 123         final org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry delegateCohortRegistry =
 124                 (org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry) delegateExtensions.get(
 125                         org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry.class);
 126         if (delegateCohortRegistry != null) {
 127             extBuilder.put(DOMDataTreeCommitCohortRegistry.class, delegateCohortRegistry::registerCommitCohort);
 128         }
 129
 130         extensions = extBuilder.build();
 131     }
 132
 133     @Override
 134     protected org.opendaylight.mdsal.dom.api.DOMDataBroker delegate() {
 135         return delegate;
 136     }
 137
 138     @Override
 139     public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
 140         return extensions;
 141     }
 142
 143     @Override
 144     public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
 145         return new DOMDataReadOnlyTransactionAdapter(delegate().newReadOnlyTransaction());
 146     }
 147
 148     @Override
 149     public DOMDataReadWriteTransaction newReadWriteTransaction() {
 150         return new DOMDataTransactionAdapter(delegate().newReadWriteTransaction());
 151     }
 152
 153     @Override
 154     public DOMDataWriteTransaction newWriteOnlyTransaction() {
 155         return new DOMDataTransactionAdapter(delegate().newWriteOnlyTransaction());
 156     }
 157
 158     @Override
 159     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
 160         AtomicReference<DOMTransactionChain> legacyChain = new AtomicReference<>();
 161         org.opendaylight.mdsal.common.api.TransactionChainListener delegateListener =
 162                 new org.opendaylight.mdsal.common.api.TransactionChainListener() {
 163             @SuppressWarnings("rawtypes")
 164             @Override
 165             public void onTransactionChainFailed(final org.opendaylight.mdsal.common.api.TransactionChain<?, ?> chain,
 166                     final org.opendaylight.mdsal.common.api.AsyncTransaction<?, ?> transaction, final Throwable cause) {
 167                 listener.onTransactionChainFailed(legacyChain.get(),
 168                         (AsyncTransaction) () -> transaction.getIdentifier(),
 169                             cause instanceof Exception ? COMMIT_EX_MAPPER.apply((Exception)cause) : cause);
 170             }
 171
 172             @Override
 173             public void onTransactionChainSuccessful(org.opendaylight.mdsal.common.api.TransactionChain<?, ?> chain) {
 174                 listener.onTransactionChainSuccessful(legacyChain.get());
 175             }
 176         };
 177
 178         final org.opendaylight.mdsal.dom.api.DOMTransactionChain delegateChain =
 179                 delegate().createTransactionChain(delegateListener);
 180         legacyChain.set(new DOMTransactionChain() {
 181             @Override
 182             public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
 183                 return new DOMDataReadOnlyTransactionAdapter(wrapException(delegateChain::newReadOnlyTransaction));
 184             }
 185
 186             @Override
 187             public DOMDataReadWriteTransaction newReadWriteTransaction() {
 188                 return new DOMDataTransactionAdapter(wrapException(delegateChain::newReadWriteTransaction));
 189             }
 190
 191             @Override
 192             public DOMDataWriteTransaction newWriteOnlyTransaction() {
 193                 return new DOMDataTransactionAdapter(wrapException(delegateChain::newWriteOnlyTransaction));
 194             }
 195
 196             @Override
 197             public void close() {
 198                 delegateChain.close();
 199             }
 200         });
 201
 202         return legacyChain.get();
 203     }
 204
 205     static <T> T wrapException(final Supplier<T> supplier) {
 206         try {
 207             return supplier.get();
 208         } catch (org.opendaylight.mdsal.common.api.TransactionChainClosedException e) {
 209             throw new TransactionChainClosedException("Transaction chain already closed", e);
 210         }
 211     }
 212
 213     private static class DOMDataTransactionAdapter implements DOMDataReadWriteTransaction {
 214         private final DOMDataTreeReadTransaction readDelegate;
 215         private final DOMDataTreeWriteTransaction writeDelegate;
 216         private final Object identifier;
 217
 218         DOMDataTransactionAdapter(@Nonnull DOMDataTreeReadTransaction readDelegate) {
 219             this.readDelegate = Preconditions.checkNotNull(readDelegate);
 220             this.identifier = readDelegate.getIdentifier();
 221             this.writeDelegate = null;
 222         }
 223
 224         DOMDataTransactionAdapter(@Nonnull DOMDataTreeWriteTransaction writeDelegate) {
 225             this.writeDelegate = Preconditions.checkNotNull(writeDelegate);
 226             this.identifier = writeDelegate.getIdentifier();
 227             this.readDelegate = null;
 228         }
 229
 230         DOMDataTransactionAdapter(@Nonnull DOMDataTreeReadWriteTransaction rwDelegate) {
 231             this.readDelegate = Preconditions.checkNotNull(rwDelegate);
 232             this.writeDelegate = rwDelegate;
 233             this.identifier = readDelegate.getIdentifier();
 234         }
 235
 236         DOMDataTreeReadTransaction readDelegate() {
 237             return readDelegate;
 238         }
 239
 240         DOMDataTreeWriteTransaction writeDelegate() {
 241             return writeDelegate;
 242         }
 243
 244         @Override
 245         public Object getIdentifier() {
 246             return identifier;
 247         }
 248
 249         @Override
 250         public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(final LogicalDatastoreType store,
 251                 final YangInstanceIdentifier path) {
 252             return MappingCheckedFuture.create(readDelegate().read(store.toMdsal(), path).transform(
 253                 Optional::fromJavaUtil, MoreExecutors.directExecutor()), ReadFailedExceptionAdapter.INSTANCE);
 254         }
 255
 256         @Override
 257         public CheckedFuture<Boolean, ReadFailedException> exists(final LogicalDatastoreType store,
 258                 final YangInstanceIdentifier path) {
 259             return MappingCheckedFuture.create(readDelegate().exists(store.toMdsal(), path),
 260                     ReadFailedExceptionAdapter.INSTANCE);
 261         }
 262
 263         @Override
 264         public void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
 265             writeDelegate().delete(store.toMdsal(), path);
 266         }
 267
 268         @Override
 269         public void put(final LogicalDatastoreType store, final YangInstanceIdentifier path,
 270                 final NormalizedNode<?, ?> data) {
 271             writeDelegate().put(store.toMdsal(), path, data);
 272         }
 273
 274         @Override
 275         public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path,
 276                 final NormalizedNode<?, ?> data) {
 277             writeDelegate().merge(store.toMdsal(), path, data);
 278         }
 279
 280         @Override
 281         public boolean cancel() {
 282             return writeDelegate().cancel();
 283         }
 284
 285         @Override
 286         public FluentFuture<? extends CommitInfo> commit() {
 287             final SettableFuture<CommitInfo> resultFuture = SettableFuture.create();
 288             writeDelegate().commit().addCallback(new FutureCallback<CommitInfo>() {
 289                 @Override
 290                 public void onSuccess(CommitInfo result) {
 291                     resultFuture.set(result);
 292                 }
 293
 294                 @Override
 295                 public void onFailure(Throwable ex) {
 296                     if (ex instanceof Exception) {
 297                         resultFuture.setException(COMMIT_EX_MAPPER.apply((Exception)ex));
 298                     } else {
 299                         resultFuture.setException(ex);
 300                     }
 301                 }
 302             }, MoreExecutors.directExecutor());
 303
 304             return resultFuture;
 305         }
 306     }
 307
 308     private static class DOMDataReadOnlyTransactionAdapter implements DOMDataReadOnlyTransaction {
 309         private final DOMDataTransactionAdapter adapter;
 310
 311         DOMDataReadOnlyTransactionAdapter(DOMDataTreeReadTransaction delegateTx) {
 312             adapter = new DOMDataTransactionAdapter(delegateTx);
 313         }
 314
 315         @Override
 316         public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(LogicalDatastoreType store,
 317                 YangInstanceIdentifier path) {
 318             return adapter.read(store, path);
 319         }
 320
 321         @Override
 322         public CheckedFuture<Boolean, ReadFailedException> exists(LogicalDatastoreType store,
 323                 YangInstanceIdentifier path) {
 324             return adapter.exists(store, path);
 325         }
 326
 327         @Override
 328         public Object getIdentifier() {
 329             return adapter.getIdentifier();
 330         }
 331
 332         @Override
 333         public void close() {
 334             adapter.readDelegate().close();
 335         }
 336     }
 337 }