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