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