2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.md.sal.binding.impl;
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;
17 import java.util.concurrent.Callable;
18 import java.util.concurrent.ConcurrentHashMap;
19 import java.util.concurrent.ExecutionException;
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.controller.sal.core.api.model.SchemaService;
39 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
40 import org.opendaylight.yangtools.concepts.Delegator;
41 import org.opendaylight.yangtools.concepts.ListenerRegistration;
42 import org.opendaylight.yangtools.concepts.Registration;
43 import org.opendaylight.yangtools.concepts.util.ListenerRegistry;
44 import org.opendaylight.yangtools.yang.binding.DataObject;
45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
46 import org.opendaylight.yangtools.yang.common.RpcError;
47 import org.opendaylight.yangtools.yang.common.RpcResult;
48 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
52 import com.google.common.base.Function;
53 import com.google.common.util.concurrent.AsyncFunction;
54 import com.google.common.util.concurrent.FutureCallback;
55 import com.google.common.util.concurrent.Futures;
56 import com.google.common.util.concurrent.ListenableFuture;
57 import com.google.common.util.concurrent.ListeningExecutorService;
59 public class ForwardedBackwardsCompatibleDataBroker extends AbstractForwardedDataBroker implements DataProviderService, AutoCloseable {
61 private static final Logger LOG = LoggerFactory.getLogger(ForwardedBackwardsCompatibleDataBroker.class);
63 private final ConcurrentHashMap<InstanceIdentifier<?>, CommitHandlerRegistrationImpl> commitHandlers = new ConcurrentHashMap<>();
64 private final ListeningExecutorService executorService;
66 public ForwardedBackwardsCompatibleDataBroker(final DOMDataBroker domDataBroker,
67 final BindingIndependentMappingService mappingService, final SchemaService schemaService,final ListeningExecutorService executor) {
68 super(domDataBroker, mappingService,schemaService);
69 executorService = executor;
70 LOG.info("ForwardedBackwardsCompatibleBroker started.");
74 public DataModificationTransaction beginTransaction() {
75 return new ForwardedBackwardsCompatibleTransacion(getDelegate().newReadWriteTransaction(), getCodec());
79 public DataObject readConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
80 DataModificationTransaction tx = beginTransaction();
81 return tx.readConfigurationData(path);
85 public DataObject readOperationalData(final InstanceIdentifier<? extends DataObject> path) {
86 DataModificationTransaction tx = beginTransaction();
87 return tx.readOperationalData(path);
91 public Registration<DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject>> registerCommitHandler(
92 final InstanceIdentifier<? extends DataObject> path,
93 final DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject> commitHandler) {
96 //transformingCommitHandler = new TransformingDataChangeListener
97 //fakeCommitHandler = registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, path, listener, DataChangeScope.SUBTREE);
99 CommitHandlerRegistrationImpl reg = new CommitHandlerRegistrationImpl(path, commitHandler);
100 commitHandlers.put(path, reg);
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.");
112 public ListenerRegistration<DataChangeListener> registerDataChangeListener(
113 final InstanceIdentifier<? extends DataObject> path, final DataChangeListener listener) {
116 BindingDataChangeListener asyncOperListener = new BackwardsCompatibleOperationalDataChangeInvoker(listener);
117 BindingDataChangeListener asyncCfgListener = new BackwardsCompatibleConfigurationDataChangeInvoker(listener);
119 ListenerRegistration<BindingDataChangeListener> cfgReg = registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, path, asyncCfgListener, DataChangeScope.SUBTREE);
120 ListenerRegistration<BindingDataChangeListener> operReg = registerDataChangeListener(LogicalDatastoreType.OPERATIONAL, path, asyncOperListener, DataChangeScope.SUBTREE);
122 return new LegacyListenerRegistration(listener,cfgReg,operReg);
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.");
132 public ListenableFuture<RpcResult<TransactionStatus>> commit(final ForwardedBackwardsCompatibleTransacion tx) {
134 final List<DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject>> subTrans = new ArrayList<>();
135 LOG.debug("Tx: {} Submitted.",tx.getIdentifier());
136 ListenableFuture<Boolean> requestCommit = executorService.submit(new Callable<Boolean>() {
139 public Boolean call() throws Exception {
141 for (CommitHandlerRegistrationImpl handler : commitHandlers.values()) {
143 DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx = handler
144 .getInstance().requestCommit(tx);
147 } catch (Exception e) {
148 LOG.error("Tx: {} Rollback.",tx.getIdentifier(),e);
149 for (DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx : subTrans) {
154 LOG.debug("Tx: {} Can Commit True.",tx.getIdentifier());
160 ListenableFuture<RpcResult<TransactionStatus>> dataStoreCommit = Futures.transform(requestCommit, new AsyncFunction<Boolean, RpcResult<TransactionStatus>>() {
163 public ListenableFuture<RpcResult<TransactionStatus>> apply(final Boolean requestCommitSuccess) throws Exception {
164 if(requestCommitSuccess) {
165 return tx.getDelegate().commit();
167 return Futures.immediateFuture(Rpcs.getRpcResult(false, TransactionStatus.FAILED, Collections.<RpcError>emptySet()));
171 return Futures.transform(dataStoreCommit, new Function<RpcResult<TransactionStatus>,RpcResult<TransactionStatus>>() {
173 public RpcResult<TransactionStatus> apply(final RpcResult<TransactionStatus> input) {
174 if(input.isSuccessful()) {
175 for(DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx : subTrans ) {
179 LOG.error("Tx: {} Rollback - Datastore commit failed.",tx.getIdentifier());
180 for(DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx : subTrans ) {
189 private class ForwardedBackwardsCompatibleTransacion extends
190 AbstractForwardedTransaction<DOMDataReadWriteTransaction> implements DataModificationTransaction {
192 private final ListenerRegistry<DataTransactionListener> listeners = ListenerRegistry.create();
193 private final Map<InstanceIdentifier<? extends DataObject>, DataObject> updated = new HashMap<>();
194 private final Map<InstanceIdentifier<? extends DataObject>, DataObject> created = new HashMap<>();
195 private final Set<InstanceIdentifier<? extends DataObject>> removed = new HashSet<>();
196 private final Map<InstanceIdentifier<? extends DataObject>, DataObject> original = new HashMap<>();
197 private TransactionStatus status = TransactionStatus.NEW;
199 private final Set<InstanceIdentifier<? extends DataObject>> posponedRemovedOperational = new HashSet<>();
200 private final Set<InstanceIdentifier<? extends DataObject>> posponedRemovedConfiguration = new HashSet<>();
204 public final TransactionStatus getStatus() {
208 protected ForwardedBackwardsCompatibleTransacion(final DOMDataReadWriteTransaction delegate,
209 final BindingToNormalizedNodeCodec codec) {
210 super(delegate, codec);
211 LOG.debug("Tx {} allocated.",getIdentifier());
215 public void putOperationalData(final InstanceIdentifier<? extends DataObject> path, final DataObject data) {
216 boolean previouslyRemoved = posponedRemovedOperational.remove(path);
217 if(previouslyRemoved) {
218 doPutWithEnsureParents(getDelegate(), LogicalDatastoreType.OPERATIONAL, path, data);
220 doMergeWithEnsureParents(getDelegate(), LogicalDatastoreType.OPERATIONAL, path, data);
225 public void putConfigurationData(final InstanceIdentifier<? extends DataObject> path, final DataObject data) {
226 boolean previouslyRemoved = posponedRemovedConfiguration.remove(path);
227 DataObject originalObj = readConfigurationData(path);
228 if (originalObj != null) {
229 original.put(path, originalObj);
232 created.put(path, data);
234 updated.put(path, data);
235 if(previouslyRemoved) {
236 doPutWithEnsureParents(getDelegate(), LogicalDatastoreType.CONFIGURATION, path, data);
238 doMergeWithEnsureParents(getDelegate(), LogicalDatastoreType.CONFIGURATION, path, data);
243 public void removeOperationalData(final InstanceIdentifier<? extends DataObject> path) {
244 posponedRemovedOperational.add(path);
248 public void removeConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
249 posponedRemovedConfiguration.add(path);
253 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getCreatedOperationalData() {
254 return Collections.emptyMap();
258 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getCreatedConfigurationData() {
263 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getUpdatedOperationalData() {
264 return Collections.emptyMap();
268 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getUpdatedConfigurationData() {
273 public Set<InstanceIdentifier<? extends DataObject>> getRemovedConfigurationData() {
278 public Set<InstanceIdentifier<? extends DataObject>> getRemovedOperationalData() {
279 return Collections.emptySet();
283 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getOriginalConfigurationData() {
288 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getOriginalOperationalData() {
289 return Collections.emptyMap();
293 public DataObject readOperationalData(final InstanceIdentifier<? extends DataObject> path) {
295 return doRead(getDelegate(), LogicalDatastoreType.OPERATIONAL, path).get().orNull();
296 } catch (InterruptedException | ExecutionException e) {
297 LOG.error("Read of {} failed.", path,e);
303 public DataObject readConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
305 return doRead(getDelegate(), LogicalDatastoreType.CONFIGURATION, path).get().orNull();
306 } catch (InterruptedException | ExecutionException e) {
307 LOG.error("Read of {} failed.", path,e);
313 public Object getIdentifier() {
314 return getDelegate().getIdentifier();
317 private void changeStatus(final TransactionStatus status) {
318 LOG.trace("Transaction {} changed status to {}", getIdentifier(), status);
319 this.status = status;
321 for(ListenerRegistration<DataTransactionListener> listener : listeners) {
323 listener.getInstance().onStatusUpdated(this, status);
324 } catch (Exception e) {
325 LOG.error("Error during invoking transaction listener {}",listener.getInstance(),e);
331 public ListenableFuture<RpcResult<TransactionStatus>> commit() {
333 for(InstanceIdentifier<? extends DataObject> path : posponedRemovedConfiguration) {
334 doDelete(getDelegate(), LogicalDatastoreType.CONFIGURATION, path);
337 for(InstanceIdentifier<? extends DataObject> path : posponedRemovedOperational) {
338 doDelete(getDelegate(), LogicalDatastoreType.OPERATIONAL, path);
341 changeStatus(TransactionStatus.SUBMITED);
343 final ListenableFuture<RpcResult<TransactionStatus>> f = ForwardedBackwardsCompatibleDataBroker.this.commit(this);
345 Futures.addCallback(f, new FutureCallback<RpcResult<TransactionStatus>>() {
347 public void onSuccess(final RpcResult<TransactionStatus> result) {
348 changeStatus(result.getResult());
352 public void onFailure(final Throwable t) {
353 LOG.error("Transaction {} failed to complete", getIdentifier(), t);
354 changeStatus(TransactionStatus.FAILED);
362 public ListenerRegistration<DataTransactionListener> registerListener(final DataTransactionListener listener) {
363 return listeners.register(listener);
368 private class CommitHandlerRegistrationImpl extends
369 AbstractObjectRegistration<DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject>> {
371 private final InstanceIdentifier<? extends DataObject> path;
373 public CommitHandlerRegistrationImpl(final InstanceIdentifier<? extends DataObject> path,
374 final DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject> commitHandler) {
375 super(commitHandler);
380 protected void removeRegistration() {
381 commitHandlers.remove(path, this);
387 private static final class LegacyListenerRegistration implements ListenerRegistration<DataChangeListener> {
389 private final DataChangeListener instance;
390 private final ListenerRegistration<BindingDataChangeListener> cfgReg;
391 private final ListenerRegistration<BindingDataChangeListener> operReg;
393 public LegacyListenerRegistration(final DataChangeListener listener,
394 final ListenerRegistration<BindingDataChangeListener> cfgReg,
395 final ListenerRegistration<BindingDataChangeListener> operReg) {
396 this.instance = listener;
397 this.cfgReg = cfgReg;
398 this.operReg = operReg;
402 public DataChangeListener getInstance() {
407 public void close() {
414 private static class BackwardsCompatibleOperationalDataChangeInvoker implements BindingDataChangeListener, Delegator<DataChangeListener> {
416 private final org.opendaylight.controller.md.sal.common.api.data.DataChangeListener<?,?> delegate;
419 public BackwardsCompatibleOperationalDataChangeInvoker(final DataChangeListener listener) {
420 this.delegate = listener;
423 @SuppressWarnings({ "unchecked", "rawtypes" })
425 public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
427 DataChangeEvent legacyChange = LegacyDataChangeEvent.createOperational(change);
428 delegate.onDataChanged(legacyChange);
433 public DataChangeListener getDelegate() {
434 return (DataChangeListener) delegate;
439 private static class BackwardsCompatibleConfigurationDataChangeInvoker implements BindingDataChangeListener, Delegator<DataChangeListener> {
440 private final org.opendaylight.controller.md.sal.common.api.data.DataChangeListener<?,?> delegate;
442 public BackwardsCompatibleConfigurationDataChangeInvoker(final DataChangeListener listener) {
443 this.delegate = listener;
446 @SuppressWarnings({ "unchecked", "rawtypes" })
448 public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
450 DataChangeEvent legacyChange = LegacyDataChangeEvent.createConfiguration(change);
452 delegate.onDataChanged(legacyChange);
457 public DataChangeListener getDelegate() {
458 return (DataChangeListener) delegate;