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.compat;
10 import com.google.common.base.Function;
11 import com.google.common.util.concurrent.AsyncFunction;
12 import com.google.common.util.concurrent.FutureCallback;
13 import com.google.common.util.concurrent.Futures;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import com.google.common.util.concurrent.ListeningExecutorService;
16 import java.util.ArrayList;
17 import java.util.Collections;
18 import java.util.HashMap;
19 import java.util.HashSet;
20 import java.util.List;
23 import java.util.concurrent.Callable;
24 import java.util.concurrent.ConcurrentHashMap;
25 import java.util.concurrent.ExecutionException;
26 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
27 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
28 import org.opendaylight.controller.md.sal.common.api.RegistrationListener;
29 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
30 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
31 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
32 import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent;
33 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler;
34 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler.DataCommitTransaction;
35 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandlerRegistration;
36 import org.opendaylight.controller.md.sal.common.api.data.DataReader;
37 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
38 import org.opendaylight.controller.md.sal.common.impl.service.AbstractDataTransaction;
39 import org.opendaylight.controller.sal.binding.api.data.DataChangeListener;
40 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
41 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
42 import org.opendaylight.controller.sal.binding.codegen.impl.SingletonHolder;
43 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
44 import org.opendaylight.yangtools.concepts.Delegator;
45 import org.opendaylight.yangtools.concepts.ListenerRegistration;
46 import org.opendaylight.yangtools.concepts.Registration;
47 import org.opendaylight.yangtools.util.ListenerRegistry;
48 import org.opendaylight.yangtools.yang.binding.DataObject;
49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
50 import org.opendaylight.yangtools.yang.common.RpcResult;
51 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
56 public class HydrogenDataBrokerAdapter implements DataProviderService, AutoCloseable {
58 private static final Logger LOG = LoggerFactory.getLogger(HydrogenDataBrokerAdapter.class);
60 private final ConcurrentHashMap<InstanceIdentifier<?>, CommitHandlerRegistrationImpl> commitHandlers = new ConcurrentHashMap<>();
61 private final ListeningExecutorService executorService = SingletonHolder.getDefaultCommitExecutor();
63 private final DataBroker delegate;
65 public HydrogenDataBrokerAdapter(final DataBroker dataBroker) {
66 delegate = dataBroker;
67 LOG.info("ForwardedBackwardsCompatibleBroker started.");
71 public DataModificationTransaction beginTransaction() {
72 return new ForwardedBackwardsCompatibleTransacion(delegate.newReadWriteTransaction());
76 public DataObject readConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
77 DataModificationTransaction tx = beginTransaction();
78 return tx.readConfigurationData(path);
82 public DataObject readOperationalData(final InstanceIdentifier<? extends DataObject> path) {
83 DataModificationTransaction tx = beginTransaction();
84 return tx.readOperationalData(path);
88 public Registration registerCommitHandler(
89 final InstanceIdentifier<? extends DataObject> path,
90 final DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject> commitHandler) {
91 CommitHandlerRegistrationImpl reg = new CommitHandlerRegistrationImpl(path, commitHandler);
92 commitHandlers.put(path, reg);
98 public ListenerRegistration<RegistrationListener<DataCommitHandlerRegistration<InstanceIdentifier<? extends DataObject>, DataObject>>> registerCommitHandlerListener(
99 final RegistrationListener<DataCommitHandlerRegistration<InstanceIdentifier<? extends DataObject>, DataObject>> commitHandlerListener) {
100 throw new UnsupportedOperationException("Not supported contract.");
104 public ListenerRegistration<DataChangeListener> registerDataChangeListener(
105 final InstanceIdentifier<? extends DataObject> path, final DataChangeListener listener) {
108 org.opendaylight.controller.md.sal.binding.api.DataChangeListener asyncOperListener = new BackwardsCompatibleOperationalDataChangeInvoker(listener);
109 org.opendaylight.controller.md.sal.binding.api.DataChangeListener asyncCfgListener = new BackwardsCompatibleConfigurationDataChangeInvoker(listener);
111 ListenerRegistration<org.opendaylight.controller.md.sal.binding.api.DataChangeListener> cfgReg = delegate.registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, path, asyncCfgListener, DataChangeScope.SUBTREE);
112 ListenerRegistration<org.opendaylight.controller.md.sal.binding.api.DataChangeListener> operReg = delegate.registerDataChangeListener(LogicalDatastoreType.OPERATIONAL, path, asyncOperListener, DataChangeScope.SUBTREE);
114 return new LegacyListenerRegistration(listener,cfgReg,operReg);
118 public Registration registerDataReader(
119 final InstanceIdentifier<? extends DataObject> path,
120 final DataReader<InstanceIdentifier<? extends DataObject>, DataObject> reader) {
121 throw new UnsupportedOperationException("Data reader contract is not supported.");
124 public ListenableFuture<RpcResult<TransactionStatus>> commit(final ForwardedBackwardsCompatibleTransacion tx) {
126 final List<DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject>> subTrans = new ArrayList<>();
127 LOG.debug("Tx: {} Submitted.",tx.getIdentifier());
128 ListenableFuture<Boolean> requestCommit = executorService.submit(new Callable<Boolean>() {
131 public Boolean call() throws Exception {
133 for (CommitHandlerRegistrationImpl handler : commitHandlers.values()) {
135 DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx = handler
136 .getInstance().requestCommit(tx);
139 } catch (Exception e) {
140 LOG.error("Tx: {} Rollback.",tx.getIdentifier(),e);
141 for (DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx : subTrans) {
146 LOG.debug("Tx: {} Can Commit True.",tx.getIdentifier());
152 ListenableFuture<RpcResult<TransactionStatus>> dataStoreCommit = Futures.transform(requestCommit, new AsyncFunction<Boolean, RpcResult<TransactionStatus>>() {
155 public ListenableFuture<RpcResult<TransactionStatus>> apply(final Boolean requestCommitSuccess) throws Exception {
156 if(requestCommitSuccess) {
157 return AbstractDataTransaction.convertToLegacyCommitFuture(tx.delegate.submit());
159 return Futures.immediateFuture(RpcResultBuilder.<TransactionStatus>failed().withResult(TransactionStatus.FAILED).build());
163 return Futures.transform(dataStoreCommit, new Function<RpcResult<TransactionStatus>,RpcResult<TransactionStatus>>() {
165 public RpcResult<TransactionStatus> apply(final RpcResult<TransactionStatus> input) {
166 if(input.isSuccessful()) {
167 for(DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx : subTrans ) {
171 LOG.error("Tx: {} Rollback - Datastore commit failed.",tx.getIdentifier());
172 for(DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> subTx : subTrans ) {
182 private class ForwardedBackwardsCompatibleTransacion implements DataModificationTransaction {
184 private final ListenerRegistry<DataTransactionListener> listeners = ListenerRegistry.create();
185 private final Map<InstanceIdentifier<? extends DataObject>, DataObject> updated = new HashMap<>();
186 private final Map<InstanceIdentifier<? extends DataObject>, DataObject> created = new HashMap<>();
187 private final Set<InstanceIdentifier<? extends DataObject>> removed = new HashSet<>();
188 private final Map<InstanceIdentifier<? extends DataObject>, DataObject> original = new HashMap<>();
189 private TransactionStatus status = TransactionStatus.NEW;
191 private final Set<InstanceIdentifier<? extends DataObject>> posponedRemovedOperational = new HashSet<>();
192 private final Set<InstanceIdentifier<? extends DataObject>> posponedRemovedConfiguration = new HashSet<>();
194 private final ReadWriteTransaction delegate;
198 public final TransactionStatus getStatus() {
202 protected ForwardedBackwardsCompatibleTransacion(final ReadWriteTransaction delegate) {
203 this.delegate = delegate;
204 LOG.debug("Tx {} allocated.",getIdentifier());
208 public void putOperationalData(final InstanceIdentifier<? extends DataObject> path, final DataObject data) {
209 boolean previouslyRemoved = posponedRemovedOperational.remove(path);
211 @SuppressWarnings({ "rawtypes", "unchecked" })
212 final InstanceIdentifier<DataObject> castedPath = (InstanceIdentifier) path;
213 if(previouslyRemoved) {
214 delegate.put(LogicalDatastoreType.OPERATIONAL, castedPath, data,true);
216 delegate.merge(LogicalDatastoreType.OPERATIONAL, castedPath, data,true);
221 public void putConfigurationData(final InstanceIdentifier<? extends DataObject> path, final DataObject data) {
222 boolean previouslyRemoved = posponedRemovedConfiguration.remove(path);
223 DataObject originalObj = readConfigurationData(path);
224 if (originalObj != null) {
225 original.put(path, originalObj);
228 created.put(path, data);
230 updated.put(path, data);
231 @SuppressWarnings({"rawtypes","unchecked"})
232 final InstanceIdentifier<DataObject> castedPath = (InstanceIdentifier) path;
233 if(previouslyRemoved) {
234 delegate.put(LogicalDatastoreType.CONFIGURATION, castedPath, data,true);
236 delegate.merge(LogicalDatastoreType.CONFIGURATION, castedPath, data,true);
241 public void removeOperationalData(final InstanceIdentifier<? extends DataObject> path) {
242 posponedRemovedOperational.add(path);
246 public void removeConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
247 posponedRemovedConfiguration.add(path);
251 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getCreatedOperationalData() {
252 return Collections.emptyMap();
256 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getCreatedConfigurationData() {
261 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getUpdatedOperationalData() {
262 return Collections.emptyMap();
266 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getUpdatedConfigurationData() {
271 public Set<InstanceIdentifier<? extends DataObject>> getRemovedConfigurationData() {
276 public Set<InstanceIdentifier<? extends DataObject>> getRemovedOperationalData() {
277 return Collections.emptySet();
281 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getOriginalConfigurationData() {
286 public Map<InstanceIdentifier<? extends DataObject>, DataObject> getOriginalOperationalData() {
287 return Collections.emptyMap();
291 public DataObject readOperationalData(final InstanceIdentifier<? extends DataObject> path) {
293 return delegate.read(LogicalDatastoreType.OPERATIONAL, path).get().orNull();
294 } catch (InterruptedException | ExecutionException e) {
295 LOG.error("Read of {} failed.", path,e);
301 public DataObject readConfigurationData(final InstanceIdentifier<? extends DataObject> path) {
303 return delegate.read(LogicalDatastoreType.CONFIGURATION, path).get().orNull();
304 } catch (InterruptedException | ExecutionException e) {
305 LOG.error("Read of {} failed.", path,e);
310 private void changeStatus(final TransactionStatus status) {
311 LOG.trace("Transaction {} changed status to {}", getIdentifier(), status);
312 this.status = status;
314 for(ListenerRegistration<DataTransactionListener> listener : listeners) {
316 listener.getInstance().onStatusUpdated(this, status);
317 } catch (Exception e) {
318 LOG.error("Error during invoking transaction listener {}",listener.getInstance(),e);
324 public ListenableFuture<RpcResult<TransactionStatus>> commit() {
326 for(InstanceIdentifier<? extends DataObject> path : posponedRemovedConfiguration) {
327 delegate.delete(LogicalDatastoreType.CONFIGURATION, path);
330 for(InstanceIdentifier<? extends DataObject> path : posponedRemovedOperational) {
331 delegate.delete(LogicalDatastoreType.OPERATIONAL, path);
334 changeStatus(TransactionStatus.SUBMITED);
336 final ListenableFuture<RpcResult<TransactionStatus>> f = HydrogenDataBrokerAdapter.this.commit(this);
338 Futures.addCallback(f, new FutureCallback<RpcResult<TransactionStatus>>() {
340 public void onSuccess(final RpcResult<TransactionStatus> result) {
341 changeStatus(result.getResult());
345 public void onFailure(final Throwable t) {
346 LOG.error("Transaction {} failed to complete", getIdentifier(), t);
347 changeStatus(TransactionStatus.FAILED);
355 public ListenerRegistration<DataTransactionListener> registerListener(final DataTransactionListener listener) {
356 return listeners.register(listener);
360 public Object getIdentifier() {
361 // TODO Auto-generated method stub
367 private class CommitHandlerRegistrationImpl extends
368 AbstractObjectRegistration<DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject>> {
370 private final InstanceIdentifier<? extends DataObject> path;
372 public CommitHandlerRegistrationImpl(final InstanceIdentifier<? extends DataObject> path,
373 final DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject> commitHandler) {
374 super(commitHandler);
379 protected void removeRegistration() {
380 commitHandlers.remove(path, this);
386 private static final class LegacyListenerRegistration implements ListenerRegistration<DataChangeListener> {
388 private final DataChangeListener instance;
389 private final ListenerRegistration<org.opendaylight.controller.md.sal.binding.api.DataChangeListener> cfgReg;
390 private final ListenerRegistration<org.opendaylight.controller.md.sal.binding.api.DataChangeListener> operReg;
392 public LegacyListenerRegistration(final DataChangeListener listener,
393 final ListenerRegistration<org.opendaylight.controller.md.sal.binding.api.DataChangeListener> cfgReg,
394 final ListenerRegistration<org.opendaylight.controller.md.sal.binding.api.DataChangeListener> operReg) {
395 this.instance = listener;
396 this.cfgReg = cfgReg;
397 this.operReg = operReg;
401 public DataChangeListener getInstance() {
406 public void close() {
413 private static class BackwardsCompatibleOperationalDataChangeInvoker implements org.opendaylight.controller.md.sal.binding.api.DataChangeListener, Delegator<DataChangeListener> {
415 private final org.opendaylight.controller.md.sal.common.api.data.DataChangeListener<?,?> delegate;
418 public BackwardsCompatibleOperationalDataChangeInvoker(final DataChangeListener listener) {
419 this.delegate = listener;
422 @SuppressWarnings({ "unchecked", "rawtypes" })
424 public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
426 DataChangeEvent legacyChange = HydrogenDataChangeEvent.createOperational(change);
427 delegate.onDataChanged(legacyChange);
432 public DataChangeListener getDelegate() {
433 return (DataChangeListener) delegate;
438 private static class BackwardsCompatibleConfigurationDataChangeInvoker implements org.opendaylight.controller.md.sal.binding.api.DataChangeListener, Delegator<DataChangeListener> {
439 private final org.opendaylight.controller.md.sal.common.api.data.DataChangeListener<?,?> delegate;
441 public BackwardsCompatibleConfigurationDataChangeInvoker(final DataChangeListener listener) {
442 this.delegate = listener;
445 @SuppressWarnings({ "unchecked", "rawtypes" })
447 public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
449 DataChangeEvent legacyChange = HydrogenDataChangeEvent.createConfiguration(change);
451 delegate.onDataChanged(legacyChange);
456 public DataChangeListener getDelegate() {
457 return (DataChangeListener) delegate;
463 public void close() throws Exception {
464 // TODO Auto-generated method stub