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         @Override
 205         public final TransactionStatus getStatus() {
 206             return status;
 207         }
 208
 209         protected ForwardedBackwardsCompatibleTransacion(final DOMDataReadWriteTransaction delegate,
 210                 final BindingToNormalizedNodeCodec codec) {
 211             super(delegate, codec);
 212             LOG.debug("Tx {} allocated.",getIdentifier());
 213         }
 214
 215         @Override
 216         public void putOperationalData(final InstanceIdentifier<? extends DataObject> path, final DataObject data) {
 217
 218             doPutWithEnsureParents(getDelegate(), LogicalDatastoreType.OPERATIONAL, path, data);
 219         }
 220
 221         @Override
 222         public void putConfigurationData(final InstanceIdentifier<? extends DataObject> path, final DataObject data) {
 223             DataObject originalObj = readConfigurationData(path);
 224             if (originalObj != null) {
 225                 original.put(path, originalObj);
 226
 227             } else {
 228                 created.put(path, data);
 229             }
 230             updated.put(path, data);
 231             doPutWithEnsureParents(getDelegate(), LogicalDatastoreType.CONFIGURATION, path, data);
 232         }
 233
 234         @Override
 235         public void removeOperationalData(final InstanceIdentifier<? extends DataObject> path) {
 236             doDelete(getDelegate(), LogicalDatastoreType.OPERATIONAL, path);
 237
 238         }
 239
 240         @Override
 241         public void removeConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
 242             doDelete(getDelegate(), LogicalDatastoreType.CONFIGURATION, path);
 243         }
 244
 245         @Override
 246         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getCreatedOperationalData() {
 247             return Collections.emptyMap();
 248         }
 249
 250         @Override
 251         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getCreatedConfigurationData() {
 252             return created;
 253         }
 254
 255         @Override
 256         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getUpdatedOperationalData() {
 257             return Collections.emptyMap();
 258         }
 259
 260         @Override
 261         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getUpdatedConfigurationData() {
 262             return updated;
 263         }
 264
 265         @Override
 266         public Set<InstanceIdentifier<? extends DataObject>> getRemovedConfigurationData() {
 267             return removed;
 268         }
 269
 270         @Override
 271         public Set<InstanceIdentifier<? extends DataObject>> getRemovedOperationalData() {
 272             return Collections.emptySet();
 273         }
 274
 275         @Override
 276         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getOriginalConfigurationData() {
 277             return original;
 278         }
 279
 280         @Override
 281         public Map<InstanceIdentifier<? extends DataObject>, DataObject> getOriginalOperationalData() {
 282             return Collections.emptyMap();
 283         }
 284
 285         @Override
 286         public DataObject readOperationalData(final InstanceIdentifier<? extends DataObject> path) {
 287             try {
 288                 return doRead(getDelegate(), LogicalDatastoreType.OPERATIONAL, path).get().orNull();
 289             } catch (InterruptedException | ExecutionException e) {
 290                 LOG.error("Read of {} failed.", path,e);
 291                 return null;
 292             }
 293         }
 294
 295         @Override
 296         public DataObject readConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
 297             try {
 298                 return doRead(getDelegate(), LogicalDatastoreType.CONFIGURATION, path).get().orNull();
 299             } catch (InterruptedException | ExecutionException e) {
 300                 LOG.error("Read of {} failed.", path,e);
 301                 return null;
 302             }
 303         }
 304
 305         @Override
 306         public Object getIdentifier() {
 307             return getDelegate().getIdentifier();
 308         }
 309
 310         private void changeStatus(TransactionStatus status) {
 311             LOG.trace("Transaction {} changed status to {}", getIdentifier(), status);
 312             this.status = status;
 313         }
 314
 315         @Override
 316         public ListenableFuture<RpcResult<TransactionStatus>> commit() {
 317             final ListenableFuture<RpcResult<TransactionStatus>> f = ForwardedBackwardsCompatibleDataBroker.this.commit(this);
 318
 319             changeStatus(TransactionStatus.SUBMITED);
 320
 321             Futures.addCallback(f, new FutureCallback<RpcResult<TransactionStatus>>() {
 322                 @Override
 323                 public void onSuccess(RpcResult<TransactionStatus> result) {
 324                     changeStatus(result.getResult());
 325                 }
 326
 327                 @Override
 328                 public void onFailure(Throwable t) {
 329                     LOG.error("Transaction {} failed to complete", getIdentifier(), t);
 330                     changeStatus(TransactionStatus.FAILED);
 331                 }
 332             });
 333
 334             return f;
 335         }
 336
 337         @Override
 338         public ListenerRegistration<DataTransactionListener> registerListener(final DataTransactionListener listener) {
 339             throw new UnsupportedOperationException();
 340         }
 341
 342     }
 343
 344     private class CommitHandlerRegistrationImpl extends
 345             AbstractObjectRegistration<DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject>> {
 346
 347         private final InstanceIdentifier<? extends DataObject> path;
 348
 349         public CommitHandlerRegistrationImpl(final InstanceIdentifier<? extends DataObject> path,
 350                 final DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject> commitHandler) {
 351             super(commitHandler);
 352             this.path = path;
 353         }
 354
 355         @Override
 356         protected void removeRegistration() {
 357             commitHandlers.remove(path, this);
 358         }
 359
 360     }
 361
 362
 363     private static final class LegacyListenerRegistration implements ListenerRegistration<DataChangeListener> {
 364
 365         private final DataChangeListener instance;
 366         private final ListenerRegistration<BindingDataChangeListener> cfgReg;
 367         private final ListenerRegistration<BindingDataChangeListener> operReg;
 368
 369         public LegacyListenerRegistration(final DataChangeListener listener,
 370                 final ListenerRegistration<BindingDataChangeListener> cfgReg,
 371                 final ListenerRegistration<BindingDataChangeListener> operReg) {
 372             this.instance = listener;
 373             this.cfgReg = cfgReg;
 374             this.operReg = operReg;
 375         }
 376
 377         @Override
 378         public DataChangeListener getInstance() {
 379             return instance;
 380         }
 381
 382         @Override
 383         public void close() {
 384             cfgReg.close();
 385             operReg.close();
 386         }
 387
 388     }
 389
 390     private static class BackwardsCompatibleOperationalDataChangeInvoker implements BindingDataChangeListener, Delegator<DataChangeListener> {
 391
 392         private final org.opendaylight.controller.md.sal.common.api.data.DataChangeListener<?,?> delegate;
 393
 394
 395         public BackwardsCompatibleOperationalDataChangeInvoker(final DataChangeListener listener) {
 396             this.delegate = listener;
 397         }
 398
 399         @SuppressWarnings({ "unchecked", "rawtypes" })
 400         @Override
 401         public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 402
 403             DataChangeEvent legacyChange = LegacyDataChangeEvent.createOperational(change);
 404             delegate.onDataChanged(legacyChange);
 405
 406         }
 407
 408         @Override
 409         public DataChangeListener getDelegate() {
 410             return (DataChangeListener) delegate;
 411         }
 412
 413     }
 414
 415     private static class BackwardsCompatibleConfigurationDataChangeInvoker implements BindingDataChangeListener, Delegator<DataChangeListener> {
 416
 417
 418         @SuppressWarnings("rawtypes")
 419         private final org.opendaylight.controller.md.sal.common.api.data.DataChangeListener<?,?> delegate;
 420
 421         public BackwardsCompatibleConfigurationDataChangeInvoker(final DataChangeListener listener) {
 422             this.delegate = listener;
 423         }
 424
 425         @SuppressWarnings({ "unchecked", "rawtypes" })
 426         @Override
 427         public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 428
 429             DataChangeEvent legacyChange = LegacyDataChangeEvent.createConfiguration(change);
 430
 431             delegate.onDataChanged(legacyChange);
 432
 433         }
 434
 435         @Override
 436         public DataChangeListener getDelegate() {
 437             return (DataChangeListener) delegate;
 438         }
 439
 440     }
 441 }