opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/ForwardedBackwardsCompatibleDataBroker.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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.md.sal.binding.impl;
   9
  10 import java.util.ArrayList;
  11 import java.util.Collections;
  12 import java.util.HashMap;
  13 import java.util.HashSet;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.Set;
  17 import java.util.concurrent.Callable;
  18 import java.util.concurrent.ConcurrentHashMap;
  19 import java.util.concurrent.ExecutionException;
  20
  21 import org.opendaylight.controller.md.sal.binding.api.BindingDataChangeListener;
  22 import org.opendaylight.controller.md.sal.common.api.RegistrationListener;
  23 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  24 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  25 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  26 import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent;
  27 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler;
  28 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler.DataCommitTransaction;
  29 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandlerRegistration;
  30 import org.opendaylight.controller.md.sal.common.api.data.DataReader;
  31 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  32 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  33 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  34 import org.opendaylight.controller.sal.binding.api.data.DataChangeListener;
  35 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  36 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  37 import org.opendaylight.controller.sal.common.util.Rpcs;
  38 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
  39 import org.opendaylight.yangtools.concepts.Delegator;
  40 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  41 import org.opendaylight.yangtools.concepts.Registration;
  42 import org.opendaylight.yangtools.concepts.util.ListenerRegistry;
  43 import org.opendaylight.yangtools.yang.binding.DataObject;
  44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  45 import org.opendaylight.yangtools.yang.common.RpcError;
  46 import org.opendaylight.yangtools.yang.common.RpcResult;
  47 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 import com.google.common.base.Function;
  52 import com.google.common.util.concurrent.AsyncFunction;
  53 import com.google.common.util.concurrent.FutureCallback;
  54 import com.google.common.util.concurrent.Futures;
  55 import com.google.common.util.concurrent.ListenableFuture;
  56 import com.google.common.util.concurrent.ListeningExecutorService;
  57
  58 public class ForwardedBackwardsCompatibleDataBroker extends AbstractForwardedDataBroker implements DataProviderService, AutoCloseable {
  59
  60     private static final Logger LOG = LoggerFactory.getLogger(ForwardedBackwardsCompatibleDataBroker.class);
  61
  62     private final ConcurrentHashMap<InstanceIdentifier<?>, CommitHandlerRegistrationImpl> commitHandlers = new ConcurrentHashMap<>();
  63     private final ListenerRegistry<DataChangeListener> fakeRegistry = ListenerRegistry.create();
  64     private final ListeningExecutorService executorService;
  65
  66     public ForwardedBackwardsCompatibleDataBroker(final DOMDataBroker domDataBroker,
  67             final BindingIndependentMappingService mappingService, final ListeningExecutorService executor) {
  68         super(domDataBroker, mappingService);
  69         executorService = executor;
  70         LOG.info("ForwardedBackwardsCompatibleBroker started.");
  71     }
  72
  73     @Override
  74     public DataModificationTransaction beginTransaction() {
  75         return new ForwardedBackwardsCompatibleTransacion(getDelegate().newReadWriteTransaction(), getCodec());
  76     }
  77
  78     @Override
  79     public DataObject readConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
  80         DataModificationTransaction tx = beginTransaction();
  81         return tx.readConfigurationData(path);
  82     }
  83
  84     @Override
  85     public DataObject readOperationalData(final InstanceIdentifier<? extends DataObject> path) {
  86         DataModificationTransaction tx = beginTransaction();
  87         return tx.readOperationalData(path);
  88     }
  89
  90     @Override
  91     public Registration<DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject>> registerCommitHandler(
  92             final InstanceIdentifier<? extends DataObject> path,
  93             final DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject> commitHandler) {
  94
  95
  96         //transformingCommitHandler = new TransformingDataChangeListener
  97         //fakeCommitHandler =  registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, path, listener, DataChangeScope.SUBTREE);
  98
  99         CommitHandlerRegistrationImpl reg = new CommitHandlerRegistrationImpl(path, commitHandler);
 100         commitHandlers.put(path, reg);
 101         return reg;
 102     }
 103
 104     @Override
 105     @Deprecated
 106     public ListenerRegistration<RegistrationListener<DataCommitHandlerRegistration<InstanceIdentifier<? extends DataObject>, DataObject>>> registerCommitHandlerListener(
 107             final RegistrationListener<DataCommitHandlerRegistration<InstanceIdentifier<? extends DataObject>, DataObject>> commitHandlerListener) {
 108         throw new UnsupportedOperationException("Not supported contract.");
 109     }
 110
 111     @Override
 112     public ListenerRegistration<DataChangeListener> registerDataChangeListener(
 113             final InstanceIdentifier<? extends DataObject> path, final DataChangeListener listener) {
 114
 115
 116         BindingDataChangeListener asyncOperListener = new BackwardsCompatibleOperationalDataChangeInvoker(listener);
 117         BindingDataChangeListener asyncCfgListener = new BackwardsCompatibleConfigurationDataChangeInvoker(listener);
 118
 119         ListenerRegistration<BindingDataChangeListener> cfgReg = registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, path, asyncCfgListener, DataChangeScope.SUBTREE);
 120         ListenerRegistration<BindingDataChangeListener> operReg = registerDataChangeListener(LogicalDatastoreType.OPERATIONAL, path, asyncOperListener, DataChangeScope.SUBTREE);
 121
 122         return new LegacyListenerRegistration(listener,cfgReg,operReg);
 123     }
 124
 125     @Override
 126     public Registration<DataReader<InstanceIdentifier<? extends DataObject>, DataObject>> registerDataReader(
 127             final InstanceIdentifier<? extends DataObject> path,
 128             final DataReader<InstanceIdentifier<? extends DataObject>, DataObject> reader) {
 129         throw new UnsupportedOperationException("Data reader contract is not supported.");
 130     }
 131
 132     @Override
 133     public void close() throws Exception {
 134         // TODO Auto-generated method stub
 135
 136     }
 137
 138     public ListenableFuture<RpcResult<TransactionStatus>> commit(final ForwardedBackwardsCompatibleTransacion tx) {
 139
 140         final List<DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject>> subTrans = new ArrayList<>();
 141         LOG.debug("Tx: {} Submitted.",tx.getIdentifier());
 142         ListenableFuture<Boolean> requestCommit = executorService.submit(new Callable<Boolean>() {
 143
 144             @Override
 145             public Boolean call() throws Exception {
 146                 try {
 147                     for (CommitHandlerRegistrationImpl handler : commitHandlers.values()) {
 148
 149                         DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx = handler
 150                                 .getInstance().requestCommit(tx);
 151                         subTrans.add(subTx);
 152                     }
 153                 } catch (Exception e) {
 154                     LOG.error("Tx: {} Rollback.",tx.getIdentifier(),e);
 155                     for (DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx : subTrans) {
 156                         subTx.rollback();
 157                     }
 158                     return false;
 159                 }
 160                 LOG.debug("Tx: {} Can Commit True.",tx.getIdentifier());
 161                 return true;
 162             }
 163
 164         });
 165
 166         ListenableFuture<RpcResult<TransactionStatus>> dataStoreCommit = Futures.transform(requestCommit, new AsyncFunction<Boolean, RpcResult<TransactionStatus>>() {
 167
 168             @Override
 169             public ListenableFuture<RpcResult<TransactionStatus>> apply(final Boolean requestCommitSuccess) throws Exception {
 170                 if(requestCommitSuccess) {
 171                     return tx.getDelegate().commit();
 172                 }
 173                 return Futures.immediateFuture(Rpcs.getRpcResult(false, TransactionStatus.FAILED, Collections.<RpcError>emptySet()));
 174             }
 175         });
 176
 177         return Futures.transform(dataStoreCommit, new Function<RpcResult<TransactionStatus>,RpcResult<TransactionStatus>>() {
 178             @Override
 179             public RpcResult<TransactionStatus> apply(final RpcResult<TransactionStatus> input) {
 180                 if(input.isSuccessful()) {
 181                     for(DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx : subTrans ) {
 182                         subTx.finish();
 183                     }
 184                 } else {
 185                     LOG.error("Tx: {} Rollback - Datastore commit failed.",tx.getIdentifier());
 186                     for(DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx : subTrans ) {
 187                         subTx.rollback();
 188                     }
 189                 }
 190                 return input;
 191             }
 192         });
 193     }
 194
 195     private class ForwardedBackwardsCompatibleTransacion extends
 196             AbstractForwardedTransaction<DOMDataReadWriteTransaction> implements DataModificationTransaction {
 197
 198         private final Map<InstanceIdentifier<? extends DataObject>, DataObject> updated = new HashMap<>();
 199         private final Map<InstanceIdentifier<? extends DataObject>, DataObject> created = new HashMap<>();
 200         private final Set<InstanceIdentifier<? extends DataObject>> removed = new HashSet<>();
 201         private final Map<InstanceIdentifier<? extends DataObject>, DataObject> original = new HashMap<>();
 202         private TransactionStatus status = TransactionStatus.NEW;
 203
 204         private final Set<InstanceIdentifier<? extends DataObject>> posponedRemovedOperational = new HashSet<>();
 205         private final Set<InstanceIdentifier<? extends DataObject>> posponedRemovedConfiguration = new HashSet<>();
 206
 207
 208         @Override
 209         public final TransactionStatus getStatus() {
 210             return status;
 211         }
 212
 213         protected ForwardedBackwardsCompatibleTransacion(final DOMDataReadWriteTransaction delegate,
 214                 final BindingToNormalizedNodeCodec codec) {
 215             super(delegate, codec);
 216             LOG.debug("Tx {} allocated.",getIdentifier());
 217         }
 218
 219         @Override
 220         public void putOperationalData(final InstanceIdentifier<? extends DataObject> path, final DataObject data) {
 221             boolean previouslyRemoved = posponedRemovedOperational.remove(path);
 222             if(previouslyRemoved) {
 223                 doPutWithEnsureParents(getDelegate(), LogicalDatastoreType.OPERATIONAL, path, data);
 224             } else {
 225                 doMergeWithEnsureParents(getDelegate(), LogicalDatastoreType.OPERATIONAL, path, data);
 226             }
 227         }
 228
 229         @Override
 230         public void putConfigurationData(final InstanceIdentifier<? extends DataObject> path, final DataObject data) {
 231             boolean previouslyRemoved = posponedRemovedConfiguration.remove(path);
 232             DataObject originalObj = readConfigurationData(path);
 233             if (originalObj != null) {
 234                 original.put(path, originalObj);
 235
 236             } else {
 237                 created.put(path, data);
 238             }
 239             updated.put(path, data);
 240             if(previouslyRemoved) {
 241                 doPutWithEnsureParents(getDelegate(), LogicalDatastoreType.CONFIGURATION, path, data);
 242             } else {
 243                 doMergeWithEnsureParents(getDelegate(), LogicalDatastoreType.CONFIGURATION, path, data);
 244             }
 245         }
 246
 247         @Override
 248         public void removeOperationalData(final InstanceIdentifier<? extends DataObject> path) {
 249             posponedRemovedOperational.add(path);
 250         }
 251
 252         @Override
 253         public void removeConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
 254             posponedRemovedConfiguration.add(path);
 255         }
 256
 257         @Override
 258         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getCreatedOperationalData() {
 259             return Collections.emptyMap();
 260         }
 261
 262         @Override
 263         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getCreatedConfigurationData() {
 264             return created;
 265         }
 266
 267         @Override
 268         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getUpdatedOperationalData() {
 269             return Collections.emptyMap();
 270         }
 271
 272         @Override
 273         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getUpdatedConfigurationData() {
 274             return updated;
 275         }
 276
 277         @Override
 278         public Set<InstanceIdentifier<? extends DataObject>> getRemovedConfigurationData() {
 279             return removed;
 280         }
 281
 282         @Override
 283         public Set<InstanceIdentifier<? extends DataObject>> getRemovedOperationalData() {
 284             return Collections.emptySet();
 285         }
 286
 287         @Override
 288         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getOriginalConfigurationData() {
 289             return original;
 290         }
 291
 292         @Override
 293         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getOriginalOperationalData() {
 294             return Collections.emptyMap();
 295         }
 296
 297         @Override
 298         public DataObject readOperationalData(final InstanceIdentifier<? extends DataObject> path) {
 299             try {
 300                 return doRead(getDelegate(), LogicalDatastoreType.OPERATIONAL, path).get().orNull();
 301             } catch (InterruptedException | ExecutionException e) {
 302                 LOG.error("Read of {} failed.", path,e);
 303                 return null;
 304             }
 305         }
 306
 307         @Override
 308         public DataObject readConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
 309             try {
 310                 return doRead(getDelegate(), LogicalDatastoreType.CONFIGURATION, path).get().orNull();
 311             } catch (InterruptedException | ExecutionException e) {
 312                 LOG.error("Read of {} failed.", path,e);
 313                 return null;
 314             }
 315         }
 316
 317         @Override
 318         public Object getIdentifier() {
 319             return getDelegate().getIdentifier();
 320         }
 321
 322         private void changeStatus(final TransactionStatus status) {
 323             LOG.trace("Transaction {} changed status to {}", getIdentifier(), status);
 324             this.status = status;
 325         }
 326
 327         @Override
 328         public ListenableFuture<RpcResult<TransactionStatus>> commit() {
 329
 330             for(InstanceIdentifier<? extends DataObject> path : posponedRemovedConfiguration) {
 331                 doDelete(getDelegate(), LogicalDatastoreType.CONFIGURATION, path);
 332             }
 333
 334             for(InstanceIdentifier<? extends DataObject> path : posponedRemovedOperational) {
 335                 doDelete(getDelegate(), LogicalDatastoreType.OPERATIONAL, path);
 336             }
 337
 338             final ListenableFuture<RpcResult<TransactionStatus>> f = ForwardedBackwardsCompatibleDataBroker.this.commit(this);
 339
 340             changeStatus(TransactionStatus.SUBMITED);
 341
 342             Futures.addCallback(f, new FutureCallback<RpcResult<TransactionStatus>>() {
 343                 @Override
 344                 public void onSuccess(final RpcResult<TransactionStatus> result) {
 345                     changeStatus(result.getResult());
 346                 }
 347
 348                 @Override
 349                 public void onFailure(final Throwable t) {
 350                     LOG.error("Transaction {} failed to complete", getIdentifier(), t);
 351                     changeStatus(TransactionStatus.FAILED);
 352                 }
 353             });
 354
 355             return f;
 356         }
 357
 358         @Override
 359         public ListenerRegistration<DataTransactionListener> registerListener(final DataTransactionListener listener) {
 360             throw new UnsupportedOperationException();
 361         }
 362
 363     }
 364
 365     private class CommitHandlerRegistrationImpl extends
 366             AbstractObjectRegistration<DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject>> {
 367
 368         private final InstanceIdentifier<? extends DataObject> path;
 369
 370         public CommitHandlerRegistrationImpl(final InstanceIdentifier<? extends DataObject> path,
 371                 final DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject> commitHandler) {
 372             super(commitHandler);
 373             this.path = path;
 374         }
 375
 376         @Override
 377         protected void removeRegistration() {
 378             commitHandlers.remove(path, this);
 379         }
 380
 381     }
 382
 383
 384     private static final class LegacyListenerRegistration implements ListenerRegistration<DataChangeListener> {
 385
 386         private final DataChangeListener instance;
 387         private final ListenerRegistration<BindingDataChangeListener> cfgReg;
 388         private final ListenerRegistration<BindingDataChangeListener> operReg;
 389
 390         public LegacyListenerRegistration(final DataChangeListener listener,
 391                 final ListenerRegistration<BindingDataChangeListener> cfgReg,
 392                 final ListenerRegistration<BindingDataChangeListener> operReg) {
 393             this.instance = listener;
 394             this.cfgReg = cfgReg;
 395             this.operReg = operReg;
 396         }
 397
 398         @Override
 399         public DataChangeListener getInstance() {
 400             return instance;
 401         }
 402
 403         @Override
 404         public void close() {
 405             cfgReg.close();
 406             operReg.close();
 407         }
 408
 409     }
 410
 411     private static class BackwardsCompatibleOperationalDataChangeInvoker implements BindingDataChangeListener, Delegator<DataChangeListener> {
 412
 413         private final org.opendaylight.controller.md.sal.common.api.data.DataChangeListener<?,?> delegate;
 414
 415
 416         public BackwardsCompatibleOperationalDataChangeInvoker(final DataChangeListener listener) {
 417             this.delegate = listener;
 418         }
 419
 420         @SuppressWarnings({ "unchecked", "rawtypes" })
 421         @Override
 422         public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 423
 424             DataChangeEvent legacyChange = LegacyDataChangeEvent.createOperational(change);
 425             delegate.onDataChanged(legacyChange);
 426
 427         }
 428
 429         @Override
 430         public DataChangeListener getDelegate() {
 431             return (DataChangeListener) delegate;
 432         }
 433
 434     }
 435
 436     private static class BackwardsCompatibleConfigurationDataChangeInvoker implements BindingDataChangeListener, Delegator<DataChangeListener> {
 437
 438
 439         @SuppressWarnings("rawtypes")
 440         private final org.opendaylight.controller.md.sal.common.api.data.DataChangeListener<?,?> delegate;
 441
 442         public BackwardsCompatibleConfigurationDataChangeInvoker(final DataChangeListener listener) {
 443             this.delegate = listener;
 444         }
 445
 446         @SuppressWarnings({ "unchecked", "rawtypes" })
 447         @Override
 448         public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 449
 450             DataChangeEvent legacyChange = LegacyDataChangeEvent.createConfiguration(change);
 451
 452             delegate.onDataChanged(legacyChange);
 453
 454         }
 455
 456         @Override
 457         public DataChangeListener getDelegate() {
 458             return (DataChangeListener) delegate;
 459         }
 460
 461     }
 462 }