2 * Copyright (c) 2013 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.sal.binding.impl.connect.dom;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
13 import java.lang.ref.WeakReference;
14 import java.lang.reflect.InvocationHandler;
15 import java.lang.reflect.Method;
16 import java.lang.reflect.Proxy;
17 import java.util.Collection;
18 import java.util.Collections;
19 import java.util.HashMap;
20 import java.util.HashSet;
22 import java.util.Map.Entry;
24 import java.util.WeakHashMap;
25 import java.util.concurrent.Callable;
26 import java.util.concurrent.ConcurrentHashMap;
27 import java.util.concurrent.ConcurrentMap;
28 import java.util.concurrent.ExecutionException;
29 import java.util.concurrent.Future;
31 import org.opendaylight.controller.md.sal.common.api.RegistrationListener;
32 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
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.DataModification;
37 import org.opendaylight.controller.md.sal.common.api.data.DataReader;
38 import org.opendaylight.controller.md.sal.common.api.routing.RouteChange;
39 import org.opendaylight.controller.md.sal.common.api.routing.RouteChangeListener;
40 import org.opendaylight.controller.md.sal.common.api.routing.RouteChangePublisher;
41 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
42 import org.opendaylight.controller.sal.binding.api.NotificationProviderService.NotificationInterestListener;
43 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
44 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
45 import org.opendaylight.controller.sal.binding.api.data.RuntimeDataProvider;
46 import org.opendaylight.controller.sal.binding.api.rpc.RpcContextIdentifier;
47 import org.opendaylight.controller.sal.binding.api.rpc.RpcRouter;
48 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
49 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
50 import org.opendaylight.controller.sal.binding.impl.RpcProviderRegistryImpl;
51 import org.opendaylight.controller.sal.binding.impl.RpcProviderRegistryImpl.GlobalRpcRegistrationListener;
52 import org.opendaylight.controller.sal.binding.impl.RpcProviderRegistryImpl.RouterInstantiationListener;
53 import org.opendaylight.controller.sal.common.util.CommitHandlerTransactions;
54 import org.opendaylight.controller.sal.common.util.Rpcs;
55 import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
56 import org.opendaylight.controller.sal.core.api.Broker.RoutedRpcRegistration;
57 import org.opendaylight.controller.sal.core.api.Provider;
58 import org.opendaylight.controller.sal.core.api.RpcImplementation;
59 import org.opendaylight.controller.sal.core.api.RpcProvisionRegistry;
60 import org.opendaylight.controller.sal.core.api.data.DataModificationTransaction;
61 import org.opendaylight.controller.sal.core.api.notify.NotificationListener;
62 import org.opendaylight.controller.sal.core.api.notify.NotificationPublishService;
63 import org.opendaylight.yangtools.concepts.ListenerRegistration;
64 import org.opendaylight.yangtools.concepts.Registration;
65 import org.opendaylight.yangtools.concepts.util.ClassLoaderUtils;
66 import org.opendaylight.yangtools.yang.binding.Augmentable;
67 import org.opendaylight.yangtools.yang.binding.Augmentation;
68 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
69 import org.opendaylight.yangtools.yang.binding.BindingMapping;
70 import org.opendaylight.yangtools.yang.binding.DataContainer;
71 import org.opendaylight.yangtools.yang.binding.DataObject;
72 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
73 import org.opendaylight.yangtools.yang.binding.Notification;
74 import org.opendaylight.yangtools.yang.binding.RpcService;
75 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
76 import org.opendaylight.yangtools.yang.common.QName;
77 import org.opendaylight.yangtools.yang.common.RpcError;
78 import org.opendaylight.yangtools.yang.common.RpcResult;
79 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
80 import org.opendaylight.yangtools.yang.data.api.Node;
81 import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
82 import org.slf4j.Logger;
83 import org.slf4j.LoggerFactory;
85 import com.google.common.base.Function;
86 import com.google.common.base.Optional;
87 import com.google.common.collect.FluentIterable;
88 import com.google.common.collect.ImmutableList;
89 import com.google.common.collect.ImmutableSet;
90 import com.google.common.collect.ImmutableSet.Builder;
91 import com.google.common.util.concurrent.Futures;
93 public class BindingIndependentConnector implements //
94 RuntimeDataProvider, //
100 private final Logger LOG = LoggerFactory.getLogger(BindingIndependentConnector.class);
102 @SuppressWarnings("deprecation")
103 private static final InstanceIdentifier<? extends DataObject> ROOT = InstanceIdentifier.builder().toInstance();
105 private static final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier ROOT_BI = org.opendaylight.yangtools.yang.data.api.InstanceIdentifier
106 .builder().toInstance();
108 private final static Method EQUALS_METHOD;
110 private BindingIndependentMappingService mappingService;
112 private org.opendaylight.controller.sal.core.api.data.DataProviderService biDataService;
114 private DataProviderService baDataService;
116 private ConcurrentMap<Object, BindingToDomTransaction> domOpenedTransactions = new ConcurrentHashMap<>();
117 private ConcurrentMap<Object, DomToBindingTransaction> bindingOpenedTransactions = new ConcurrentHashMap<>();
119 private BindingToDomCommitHandler bindingToDomCommitHandler = new BindingToDomCommitHandler();
120 private DomToBindingCommitHandler domToBindingCommitHandler = new DomToBindingCommitHandler();
122 private Registration<DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject>> baCommitHandlerRegistration;
124 private Registration<DataCommitHandler<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode>> biCommitHandlerRegistration;
126 private RpcProvisionRegistry biRpcRegistry;
127 private RpcProviderRegistry baRpcRegistry;
129 private ListenerRegistration<DomToBindingRpcForwardingManager> domToBindingRpcManager;
130 // private ListenerRegistration<BindingToDomRpcForwardingManager>
131 // bindingToDomRpcManager;
133 private Function<InstanceIdentifier<?>, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier> toDOMInstanceIdentifier = new Function<InstanceIdentifier<?>, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier>() {
136 public org.opendaylight.yangtools.yang.data.api.InstanceIdentifier apply(InstanceIdentifier<?> input) {
137 return mappingService.toDataDom(input);
142 private Registration<DataReader<InstanceIdentifier<? extends DataObject>, DataObject>> baDataReaderRegistration;
144 private boolean rpcForwarding = false;
146 private boolean dataForwarding = false;
148 private boolean notificationForwarding = false;
150 private RpcProviderRegistryImpl baRpcRegistryImpl;
152 private org.opendaylight.controller.sal.dom.broker.spi.RpcRouter biRouter;
154 private NotificationProviderService baNotifyService;
156 private NotificationPublishService domNotificationService;
160 EQUALS_METHOD = Object.class.getMethod("equals", Object.class);
161 } catch (Exception e) {
162 throw new RuntimeException(e);
167 public DataObject readOperationalData(InstanceIdentifier<? extends DataObject> path) {
169 org.opendaylight.yangtools.yang.data.api.InstanceIdentifier biPath = mappingService.toDataDom(path);
170 CompositeNode result = biDataService.readOperationalData(biPath);
171 return potentialAugmentationRead(path, biPath, result);
172 } catch (DeserializationException e) {
173 throw new IllegalStateException(e);
177 private DataObject potentialAugmentationRead(InstanceIdentifier<? extends DataObject> path,
178 org.opendaylight.yangtools.yang.data.api.InstanceIdentifier biPath, CompositeNode result)
179 throws DeserializationException {
180 Class<? extends DataObject> targetType = path.getTargetType();
181 if (Augmentation.class.isAssignableFrom(targetType)) {
182 path = mappingService.fromDataDom(biPath);
183 Class<? extends Augmentation<?>> augmentType = (Class<? extends Augmentation<?>>) targetType;
184 DataObject parentTo = mappingService.dataObjectFromDataDom(path, result);
185 if (parentTo instanceof Augmentable<?>) {
186 return (DataObject) ((Augmentable) parentTo).getAugmentation(augmentType);
189 return mappingService.dataObjectFromDataDom(path, result);
193 public DataObject readConfigurationData(InstanceIdentifier<? extends DataObject> path) {
195 org.opendaylight.yangtools.yang.data.api.InstanceIdentifier biPath = mappingService.toDataDom(path);
196 CompositeNode result = biDataService.readConfigurationData(biPath);
197 return potentialAugmentationRead(path, biPath, result);
198 } catch (DeserializationException e) {
199 throw new IllegalStateException(e);
203 private DataModificationTransaction createBindingToDomTransaction(
204 DataModification<InstanceIdentifier<? extends DataObject>, DataObject> source) {
205 DataModificationTransaction target = biDataService.beginTransaction();
206 LOG.debug("Created DOM Transaction {} for {},", target.getIdentifier(),source.getIdentifier());
207 for (Entry<InstanceIdentifier<? extends DataObject>, DataObject> entry : source.getUpdatedConfigurationData()
209 Entry<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> biEntry = mappingService
211 target.putConfigurationData(biEntry.getKey(), biEntry.getValue());
212 LOG.debug("Update of Binding Configuration Data {} is translated to {}",entry,biEntry);
214 for (Entry<InstanceIdentifier<? extends DataObject>, DataObject> entry : source.getUpdatedOperationalData()
216 Entry<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> biEntry = mappingService
218 target.putOperationalData(biEntry.getKey(), biEntry.getValue());
219 LOG.debug("Update of Binding Operational Data {} is translated to {}",entry,biEntry);
221 for (InstanceIdentifier<? extends DataObject> entry : source.getRemovedConfigurationData()) {
222 org.opendaylight.yangtools.yang.data.api.InstanceIdentifier biEntry = mappingService.toDataDom(entry);
223 target.removeConfigurationData(biEntry);
224 LOG.debug("Delete of Binding Configuration Data {} is translated to {}",entry,biEntry);
226 for (InstanceIdentifier<? extends DataObject> entry : source.getRemovedOperationalData()) {
227 org.opendaylight.yangtools.yang.data.api.InstanceIdentifier biEntry = mappingService.toDataDom(entry);
228 target.removeOperationalData(biEntry);
229 LOG.debug("Delete of Binding Operational Data {} is translated to {}",entry,biEntry);
234 private org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction createDomToBindingTransaction(
235 DataModification<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> source) {
236 org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction target = baDataService
238 for (Entry<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> entry : source
239 .getUpdatedConfigurationData().entrySet()) {
241 InstanceIdentifier<?> baKey = mappingService.fromDataDom(entry.getKey());
242 DataObject baData = mappingService.dataObjectFromDataDom(baKey, entry.getValue());
243 target.putConfigurationData(baKey, baData);
244 } catch (DeserializationException e) {
245 LOG.error("Ommiting from BA transaction: {}.", entry.getKey(), e);
248 for (Entry<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> entry : source
249 .getUpdatedOperationalData().entrySet()) {
252 InstanceIdentifier<?> baKey = mappingService.fromDataDom(entry.getKey());
253 DataObject baData = mappingService.dataObjectFromDataDom(baKey, entry.getValue());
254 target.putOperationalData(baKey, baData);
255 } catch (DeserializationException e) {
256 LOG.error("Ommiting from BA transaction: {}.", entry.getKey(), e);
259 for (org.opendaylight.yangtools.yang.data.api.InstanceIdentifier entry : source.getRemovedConfigurationData()) {
262 InstanceIdentifier<?> baEntry = mappingService.fromDataDom(entry);
263 target.removeConfigurationData(baEntry);
264 } catch (DeserializationException e) {
265 LOG.error("Ommiting from BA transaction: {}.", entry, e);
268 for (org.opendaylight.yangtools.yang.data.api.InstanceIdentifier entry : source.getRemovedOperationalData()) {
271 InstanceIdentifier<?> baEntry = mappingService.fromDataDom(entry);
272 target.removeOperationalData(baEntry);
273 } catch (DeserializationException e) {
274 LOG.error("Ommiting from BA transaction: {}.", entry, e);
280 public org.opendaylight.controller.sal.core.api.data.DataProviderService getBiDataService() {
281 return biDataService;
284 protected void setDomDataService(org.opendaylight.controller.sal.core.api.data.DataProviderService biDataService) {
285 this.biDataService = biDataService;
288 public DataProviderService getBaDataService() {
289 return baDataService;
292 protected void setBindingDataService(DataProviderService baDataService) {
293 this.baDataService = baDataService;
296 public RpcProviderRegistry getRpcRegistry() {
297 return baRpcRegistry;
300 protected void setBindingRpcRegistry(RpcProviderRegistry rpcRegistry) {
301 this.baRpcRegistry = rpcRegistry;
304 public void startDataForwarding() {
305 checkState(!dataForwarding, "Connector is already forwarding data.");
306 baDataReaderRegistration = baDataService.registerDataReader(ROOT, this);
307 baCommitHandlerRegistration = baDataService.registerCommitHandler(ROOT, bindingToDomCommitHandler);
308 biCommitHandlerRegistration = biDataService.registerCommitHandler(ROOT_BI, domToBindingCommitHandler);
309 baDataService.registerCommitHandlerListener(domToBindingCommitHandler);
310 dataForwarding = true;
313 public void startRpcForwarding() {
314 if (baRpcRegistry != null && biRpcRegistry != null && baRpcRegistry instanceof RouteChangePublisher<?, ?>) {
315 checkState(!rpcForwarding, "Connector is already forwarding RPCs");
316 domToBindingRpcManager = baRpcRegistry.registerRouteChangeListener(new DomToBindingRpcForwardingManager());
317 if (baRpcRegistry instanceof RpcProviderRegistryImpl) {
318 baRpcRegistryImpl = (RpcProviderRegistryImpl) baRpcRegistry;
319 baRpcRegistryImpl.registerRouterInstantiationListener(domToBindingRpcManager.getInstance());
320 baRpcRegistryImpl.registerGlobalRpcRegistrationListener(domToBindingRpcManager.getInstance());
322 if (biRpcRegistry instanceof org.opendaylight.controller.sal.dom.broker.spi.RpcRouter) {
323 biRouter = (org.opendaylight.controller.sal.dom.broker.spi.RpcRouter) biRpcRegistry;
325 rpcForwarding = true;
329 public void startNotificationForwarding() {
330 checkState(!notificationForwarding, "Connector is already forwarding notifications.");
331 if (baNotifyService != null && domNotificationService != null) {
332 baNotifyService.registerInterestListener(new DomToBindingNotificationForwarder());
334 notificationForwarding = true;
338 protected void setMappingService(BindingIndependentMappingService mappingService) {
339 this.mappingService = mappingService;
343 public Collection<ProviderFunctionality> getProviderFunctionality() {
344 return Collections.emptyList();
348 public void onSessionInitiated(ProviderSession session) {
349 setDomDataService(session.getService(org.opendaylight.controller.sal.core.api.data.DataProviderService.class));
350 setDomRpcRegistry(session.getService(RpcProvisionRegistry.class));
354 public <T extends RpcService> void onRpcRouterCreated(Class<T> serviceType, RpcRouter<T> router) {
358 public void setDomRpcRegistry(RpcProvisionRegistry registry) {
359 biRpcRegistry = registry;
363 public void close() throws Exception {
364 if (baCommitHandlerRegistration != null) {
365 baCommitHandlerRegistration.close();
367 if (biCommitHandlerRegistration != null) {
368 biCommitHandlerRegistration.close();
373 private class DomToBindingTransaction implements
374 DataCommitTransaction<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> {
376 private final org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction backing;
377 private final DataModification<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> modification;
379 public DomToBindingTransaction(
380 org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction backing,
381 DataModification<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> modification) {
383 this.backing = backing;
384 this.modification = modification;
385 bindingOpenedTransactions.put(backing.getIdentifier(), this);
389 public DataModification<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> getModification() {
394 public RpcResult<Void> rollback() throws IllegalStateException {
396 return Rpcs.<Void> getRpcResult(true, null, Collections.<RpcError> emptySet());
400 public RpcResult<Void> finish() throws IllegalStateException {
401 Future<RpcResult<TransactionStatus>> result = backing.commit();
403 RpcResult<TransactionStatus> baResult = result.get();
404 return Rpcs.<Void> getRpcResult(baResult.isSuccessful(), null, baResult.getErrors());
405 } catch (InterruptedException e) {
406 throw new IllegalStateException("", e);
407 } catch (ExecutionException e) {
408 throw new IllegalStateException("", e);
413 private class BindingToDomTransaction implements
414 DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> {
416 private DataModificationTransaction backing;
417 private DataModification<InstanceIdentifier<? extends DataObject>, DataObject> modification;
419 public BindingToDomTransaction(DataModificationTransaction backing,
420 DataModification<InstanceIdentifier<? extends DataObject>, DataObject> modification) {
421 this.backing = backing;
422 this.modification = modification;
423 domOpenedTransactions.put(backing.getIdentifier(), this);
427 public DataModification<InstanceIdentifier<? extends DataObject>, DataObject> getModification() {
432 public RpcResult<Void> finish() throws IllegalStateException {
433 Future<RpcResult<TransactionStatus>> result = backing.commit();
435 RpcResult<TransactionStatus> biResult = result.get();
436 return Rpcs.<Void> getRpcResult(biResult.isSuccessful(), null, biResult.getErrors());
437 } catch (InterruptedException e) {
438 throw new IllegalStateException("", e);
439 } catch (ExecutionException e) {
440 throw new IllegalStateException("", e);
442 domOpenedTransactions.remove(backing.getIdentifier());
447 public RpcResult<Void> rollback() throws IllegalStateException {
448 domOpenedTransactions.remove(backing.getIdentifier());
449 return Rpcs.<Void> getRpcResult(true, null, Collections.<RpcError> emptySet());
453 private class BindingToDomCommitHandler implements
454 DataCommitHandler<InstanceIdentifier<? extends DataObject>, DataObject> {
457 public org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler.DataCommitTransaction<InstanceIdentifier<? extends DataObject>, DataObject> requestCommit(
458 DataModification<InstanceIdentifier<? extends DataObject>, DataObject> bindingTransaction) {
461 * Transaction was created as DOM transaction, in that case we do
462 * not need to forward it back.
464 if (bindingOpenedTransactions.containsKey(bindingTransaction.getIdentifier())) {
466 return CommitHandlerTransactions.allwaysSuccessfulTransaction(bindingTransaction);
468 DataModificationTransaction domTransaction = createBindingToDomTransaction(bindingTransaction);
469 BindingToDomTransaction wrapped = new BindingToDomTransaction(domTransaction, bindingTransaction);
470 LOG.trace("Forwarding Binding Transaction: {} as DOM Transaction: {} .", bindingTransaction.getIdentifier(),
471 domTransaction.getIdentifier());
476 private class DomToBindingCommitHandler implements //
477 RegistrationListener<DataCommitHandlerRegistration<InstanceIdentifier<? extends DataObject>, DataObject>>, //
478 DataCommitHandler<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> {
481 public void onRegister(DataCommitHandlerRegistration<InstanceIdentifier<? extends DataObject>, DataObject> registration) {
483 org.opendaylight.yangtools.yang.data.api.InstanceIdentifier domPath = mappingService.toDataDom(registration
489 public void onUnregister(DataCommitHandlerRegistration<InstanceIdentifier<? extends DataObject>, DataObject> registration) {
491 // FIXME: do registration based on only active commit handlers.
494 public org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler.DataCommitTransaction<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> requestCommit(
495 DataModification<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, CompositeNode> domTransaction) {
496 Object identifier = domTransaction.getIdentifier();
499 * We checks if the transcation was originated in this mapper. If it
500 * was originated in this mapper we are returing allways success
501 * commit hanlder to prevent creating loop in two-phase commit and
504 if (domOpenedTransactions.containsKey(identifier)) {
505 return CommitHandlerTransactions.allwaysSuccessfulTransaction(domTransaction);
508 org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction baTransaction = createDomToBindingTransaction(domTransaction);
509 DomToBindingTransaction forwardedTransaction = new DomToBindingTransaction(baTransaction, domTransaction);
510 LOG.trace("Forwarding DOM Transaction: {} as Binding Transaction: {}.", domTransaction.getIdentifier(),
511 baTransaction.getIdentifier());
512 return forwardedTransaction;
517 * Manager responsible for instantiating forwarders responsible for
518 * forwarding of RPC invocations from DOM Broker to Binding Aware Broker
521 private class DomToBindingRpcForwardingManager implements
522 RouteChangeListener<RpcContextIdentifier, InstanceIdentifier<?>>,
523 RouterInstantiationListener,
524 GlobalRpcRegistrationListener {
526 private final Map<Class<? extends RpcService>, DomToBindingRpcForwarder> forwarders = new WeakHashMap<>();
527 private RpcProviderRegistryImpl registryImpl;
529 public RpcProviderRegistryImpl getRegistryImpl() {
533 public void setRegistryImpl(RpcProviderRegistryImpl registryImpl) {
534 this.registryImpl = registryImpl;
538 public void onGlobalRpcRegistered(Class<? extends RpcService> cls) {
539 getRpcForwarder(cls, null);
543 public void onGlobalRpcUnregistered(Class<? extends RpcService> cls) {
548 public void onRpcRouterCreated(RpcRouter<?> router) {
549 Class<? extends BaseIdentity> ctx = router.getContexts().iterator().next();
550 getRpcForwarder(router.getServiceType(), ctx);
554 public void onRouteChange(RouteChange<RpcContextIdentifier, InstanceIdentifier<?>> change) {
555 for (Entry<RpcContextIdentifier, Set<InstanceIdentifier<?>>> entry : change.getAnnouncements().entrySet()) {
556 bindingRoutesAdded(entry);
560 private void bindingRoutesAdded(Entry<RpcContextIdentifier, Set<InstanceIdentifier<?>>> entry) {
561 Class<? extends BaseIdentity> context = entry.getKey().getRoutingContext();
562 Class<? extends RpcService> service = entry.getKey().getRpcService();
563 if (context != null) {
564 getRpcForwarder(service, context).registerPaths(context, service, entry.getValue());
568 private DomToBindingRpcForwarder getRpcForwarder(Class<? extends RpcService> service,
569 Class<? extends BaseIdentity> context) {
570 DomToBindingRpcForwarder potential = forwarders.get(service);
571 if (potential != null) {
574 if (context == null) {
575 potential = new DomToBindingRpcForwarder(service);
577 potential = new DomToBindingRpcForwarder(service, context);
580 forwarders.put(service, potential);
586 private class DomToBindingRpcForwarder implements RpcImplementation, InvocationHandler {
588 private final Set<QName> supportedRpcs;
589 private final WeakReference<Class<? extends RpcService>> rpcServiceType;
590 private Set<org.opendaylight.controller.sal.core.api.Broker.RoutedRpcRegistration> registrations;
591 private Map<QName, RpcInvocationStrategy> strategiesByQName = new HashMap<>();
592 private WeakHashMap<Method, RpcInvocationStrategy> strategiesByMethod = new WeakHashMap<>();
594 public DomToBindingRpcForwarder(Class<? extends RpcService> service) {
595 this.rpcServiceType = new WeakReference<Class<? extends RpcService>>(service);
596 this.supportedRpcs = mappingService.getRpcQNamesFor(service);
598 for (QName rpc : supportedRpcs) {
599 RpcInvocationStrategy strategy = createInvocationStrategy(rpc, service);
600 strategiesByMethod.put(strategy.targetMethod, strategy);
601 strategiesByQName.put(rpc, strategy);
602 biRpcRegistry.addRpcImplementation(rpc, this);
605 } catch (Exception e) {
606 LOG.error("Could not forward Rpcs of type {}", service.getName(),e);
608 registrations = ImmutableSet.of();
612 * Constructor for Routed RPC Forwareder.
617 public DomToBindingRpcForwarder(Class<? extends RpcService> service, Class<? extends BaseIdentity> context) {
618 this.rpcServiceType = new WeakReference<Class<? extends RpcService>>(service);
619 this.supportedRpcs = mappingService.getRpcQNamesFor(service);
620 Builder<RoutedRpcRegistration> registrationsBuilder = ImmutableSet
621 .<org.opendaylight.controller.sal.core.api.Broker.RoutedRpcRegistration> builder();
623 for (QName rpc : supportedRpcs) {
624 RpcInvocationStrategy strategy = createInvocationStrategy(rpc, service);
625 strategiesByMethod.put(strategy.targetMethod, strategy);
626 strategiesByQName.put(rpc, strategy);
627 registrationsBuilder.add(biRpcRegistry.addRoutedRpcImplementation(rpc, this));
629 createDefaultDomForwarder();
630 } catch (Exception e) {
631 LOG.error("Could not forward Rpcs of type {}", service.getName(), e);
633 registrations = registrationsBuilder.build();
636 public void registerPaths(Class<? extends BaseIdentity> context, Class<? extends RpcService> service,
637 Set<InstanceIdentifier<?>> set) {
638 QName ctx = BindingReflections.findQName(context);
639 for (org.opendaylight.yangtools.yang.data.api.InstanceIdentifier path : FluentIterable.from(set).transform(
640 toDOMInstanceIdentifier)) {
641 for (org.opendaylight.controller.sal.core.api.Broker.RoutedRpcRegistration reg : registrations) {
642 reg.registerPath(ctx, path);
649 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
650 if (EQUALS_METHOD.equals(method)) {
653 RpcInvocationStrategy strategy = strategiesByMethod.get(method);
654 checkState(strategy != null);
655 checkArgument(args.length <= 2);
656 if (args.length == 1) {
657 checkArgument(args[0] instanceof DataObject);
658 return strategy.forwardToDomBroker((DataObject) args[0]);
660 return strategy.forwardToDomBroker(null);
663 public void removePaths(Class<? extends BaseIdentity> context, Class<? extends RpcService> service,
664 Set<InstanceIdentifier<?>> set) {
665 QName ctx = BindingReflections.findQName(context);
666 for (org.opendaylight.yangtools.yang.data.api.InstanceIdentifier path : FluentIterable.from(set).transform(
667 toDOMInstanceIdentifier)) {
668 for (org.opendaylight.controller.sal.core.api.Broker.RoutedRpcRegistration reg : registrations) {
669 reg.unregisterPath(ctx, path);
675 public Set<QName> getSupportedRpcs() {
676 return supportedRpcs;
679 @SuppressWarnings({ "unchecked", "rawtypes" })
680 public void createDefaultDomForwarder() {
681 if (baRpcRegistryImpl != null) {
682 Class<?> cls = rpcServiceType.get();
683 ClassLoader clsLoader = cls.getClassLoader();
684 RpcService proxy = (RpcService) Proxy.newProxyInstance(clsLoader, new Class<?>[] { cls }, this);
686 RpcRouter rpcRouter = baRpcRegistryImpl.getRpcRouter(rpcServiceType.get());
687 rpcRouter.registerDefaultService(proxy);
692 public RpcResult<CompositeNode> invokeRpc(QName rpc, CompositeNode domInput) {
693 checkArgument(rpc != null);
694 checkArgument(domInput != null);
696 Class<? extends RpcService> rpcType = rpcServiceType.get();
697 checkState(rpcType != null);
698 RpcService rpcService = baRpcRegistry.getRpcService(rpcType);
699 checkState(rpcService != null);
700 CompositeNode domUnwrappedInput = domInput.getFirstCompositeByName(QName.create(rpc, "input"));
702 return resolveInvocationStrategy(rpc).invokeOn(rpcService, domUnwrappedInput);
703 } catch (Exception e) {
704 throw new IllegalStateException(e);
708 private RpcInvocationStrategy resolveInvocationStrategy(QName rpc) {
709 return strategiesByQName.get(rpc);
712 private RpcInvocationStrategy createInvocationStrategy(final QName rpc,
713 final Class<? extends RpcService> rpcType) throws Exception {
714 return ClassLoaderUtils.withClassLoader(rpcType.getClassLoader(), new Callable<RpcInvocationStrategy>() {
716 public RpcInvocationStrategy call() throws Exception {
717 String methodName = BindingMapping.getMethodName(rpc);
718 Method targetMethod = null;
719 for (Method possibleMethod : rpcType.getMethods()) {
720 if (possibleMethod.getName().equals(methodName)
721 && BindingReflections.isRpcMethod(possibleMethod)) {
722 targetMethod = possibleMethod;
726 checkState(targetMethod != null, "Rpc method not found");
727 Optional<Class<?>> outputClass = BindingReflections.resolveRpcOutputClass(targetMethod);
728 Optional<Class<? extends DataContainer>> inputClass = BindingReflections
729 .resolveRpcInputClass(targetMethod);
731 RpcInvocationStrategy strategy = null;
732 if (outputClass.isPresent()) {
733 if (inputClass.isPresent()) {
734 strategy = new DefaultInvocationStrategy(rpc, targetMethod, outputClass.get(), inputClass
737 strategy = new NoInputNoOutputInvocationStrategy(rpc, targetMethod);
739 } else if(inputClass.isPresent()){
740 strategy = new NoOutputInvocationStrategy(rpc,targetMethod, inputClass.get());
742 strategy = new NoInputNoOutputInvocationStrategy(rpc,targetMethod);
751 private abstract class RpcInvocationStrategy {
753 protected final Method targetMethod;
754 protected final QName rpc;
756 public RpcInvocationStrategy(QName rpc, Method targetMethod) {
757 this.targetMethod = targetMethod;
761 public abstract Future<RpcResult<?>> forwardToDomBroker(DataObject input);
763 public abstract RpcResult<CompositeNode> uncheckedInvoke(RpcService rpcService, CompositeNode domInput)
766 public RpcResult<CompositeNode> invokeOn(RpcService rpcService, CompositeNode domInput) throws Exception {
767 return uncheckedInvoke(rpcService, domInput);
771 private class DefaultInvocationStrategy extends RpcInvocationStrategy {
773 @SuppressWarnings("rawtypes")
774 private WeakReference<Class> inputClass;
776 @SuppressWarnings("rawtypes")
777 private WeakReference<Class> outputClass;
779 @SuppressWarnings({ "rawtypes", "unchecked" })
780 public DefaultInvocationStrategy(QName rpc, Method targetMethod, Class<?> outputClass,
781 Class<? extends DataContainer> inputClass) {
782 super(rpc, targetMethod);
783 this.outputClass = new WeakReference(outputClass);
784 this.inputClass = new WeakReference(inputClass);
787 @SuppressWarnings("unchecked")
789 public RpcResult<CompositeNode> uncheckedInvoke(RpcService rpcService, CompositeNode domInput) throws Exception {
790 DataContainer bindingInput = mappingService.dataObjectFromDataDom(inputClass.get(), domInput);
791 Future<RpcResult<?>> futureResult = (Future<RpcResult<?>>) targetMethod.invoke(rpcService, bindingInput);
792 if (futureResult == null) {
793 return Rpcs.getRpcResult(false);
795 RpcResult<?> bindingResult = futureResult.get();
796 final Object resultObj = bindingResult.getResult();
797 if (resultObj instanceof DataObject) {
798 final CompositeNode output = mappingService.toDataDom((DataObject)resultObj);
799 return Rpcs.getRpcResult(true, output, Collections.<RpcError>emptySet());
801 return Rpcs.getRpcResult(true);
805 public Future<RpcResult<?>> forwardToDomBroker(DataObject input) {
806 if(biRouter != null) {
807 CompositeNode xml = mappingService.toDataDom(input);
808 CompositeNode wrappedXml = ImmutableCompositeNode.create(rpc, ImmutableList.<Node<?>> of(xml));
809 RpcResult<CompositeNode> result = biRouter.invokeRpc(rpc, wrappedXml);
810 Object baResultValue = null;
811 if (result.getResult() != null) {
812 baResultValue = mappingService.dataObjectFromDataDom(outputClass.get(), result.getResult());
814 RpcResult<?> baResult = Rpcs.getRpcResult(result.isSuccessful(), baResultValue, result.getErrors());
815 return Futures.<RpcResult<?>> immediateFuture(baResult);
817 return Futures.<RpcResult<?>> immediateFuture(Rpcs.getRpcResult(false));
822 private class NoInputNoOutputInvocationStrategy extends RpcInvocationStrategy {
824 public NoInputNoOutputInvocationStrategy(QName rpc, Method targetMethod) {
825 super(rpc, targetMethod);
828 public RpcResult<CompositeNode> uncheckedInvoke(RpcService rpcService, CompositeNode domInput) throws Exception {
829 @SuppressWarnings("unchecked")
830 Future<RpcResult<Void>> result = (Future<RpcResult<Void>>) targetMethod.invoke(rpcService);
831 RpcResult<Void> bindingResult = result.get();
832 return Rpcs.getRpcResult(bindingResult.isSuccessful(), bindingResult.getErrors());
836 public Future<RpcResult<?>> forwardToDomBroker(DataObject input) {
837 return Futures.immediateFuture(null);
841 private class NoOutputInvocationStrategy extends RpcInvocationStrategy {
844 @SuppressWarnings("rawtypes")
845 private WeakReference<Class> inputClass;
847 @SuppressWarnings({ "rawtypes", "unchecked" })
848 public NoOutputInvocationStrategy(QName rpc, Method targetMethod,
849 Class<? extends DataContainer> inputClass) {
850 super(rpc,targetMethod);
851 this.inputClass = new WeakReference(inputClass);
856 public RpcResult<CompositeNode> uncheckedInvoke(RpcService rpcService, CompositeNode domInput) throws Exception {
857 DataContainer bindingInput = mappingService.dataObjectFromDataDom(inputClass.get(), domInput);
858 Future<RpcResult<?>> result = (Future<RpcResult<?>>) targetMethod.invoke(rpcService, bindingInput);
859 if (result == null) {
860 return Rpcs.getRpcResult(false);
862 RpcResult<?> bindingResult = result.get();
863 return Rpcs.getRpcResult(true);
867 public Future<RpcResult<?>> forwardToDomBroker(DataObject input) {
868 if(biRouter != null) {
869 CompositeNode xml = mappingService.toDataDom(input);
870 CompositeNode wrappedXml = ImmutableCompositeNode.create(rpc,ImmutableList.<Node<?>>of(xml));
871 RpcResult<CompositeNode> result = biRouter.invokeRpc(rpc, wrappedXml);
872 Object baResultValue = null;
873 RpcResult<?> baResult = Rpcs.<Void>getRpcResult(result.isSuccessful(), null, result.getErrors());
874 return Futures.<RpcResult<?>>immediateFuture(baResult);
876 return Futures.<RpcResult<?>>immediateFuture(Rpcs.getRpcResult(false));
881 public boolean isRpcForwarding() {
882 return rpcForwarding;
885 public boolean isDataForwarding() {
886 return dataForwarding;
889 public boolean isNotificationForwarding() {
890 return notificationForwarding;
893 public BindingIndependentMappingService getMappingService() {
894 return mappingService;
897 public void setBindingNotificationService(NotificationProviderService baService) {
898 this.baNotifyService = baService;
902 public void setDomNotificationService(NotificationPublishService domService) {
903 this.domNotificationService = domService;
906 private class DomToBindingNotificationForwarder implements NotificationInterestListener, NotificationListener {
908 private ConcurrentMap<QName, WeakReference<Class<? extends Notification>>> notifications = new ConcurrentHashMap<>();
909 private Set<QName> supportedNotifications = new HashSet<>();
912 public Set<QName> getSupportedNotifications() {
913 return Collections.unmodifiableSet(supportedNotifications);
917 public void onNotification(CompositeNode notification) {
918 QName qname = notification.getNodeType();
919 WeakReference<Class<? extends Notification>> potential = notifications.get(qname);
920 if (potential != null) {
921 Class<? extends Notification> potentialClass = potential.get();
922 if (potentialClass != null) {
923 final DataContainer baNotification = mappingService.dataObjectFromDataDom(potentialClass,
926 if (baNotification instanceof Notification) {
927 baNotifyService.publish((Notification) baNotification);
934 public void onNotificationSubscribtion(Class<? extends Notification> notificationType) {
935 QName qname = BindingReflections.findQName(notificationType);
937 WeakReference<Class<? extends Notification>> already = notifications.putIfAbsent(qname,
938 new WeakReference<Class<? extends Notification>>(notificationType));
939 if (already == null) {
940 domNotificationService.addNotificationListener(qname, this);
941 supportedNotifications.add(qname);