82b1b6be157edd9f82e00b279038bfaaa4d34827
[controller.git] / opendaylight / blueprint / src / main / java / org / opendaylight / controller / blueprint / ext / RpcServiceMetadata.java
1 /*
2  * Copyright (c) 2016 Brocade Communications 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.blueprint.ext;
9
10 import java.util.Collection;
11 import java.util.HashSet;
12 import java.util.Set;
13 import org.apache.aries.blueprint.services.ExtendedBlueprintContainer;
14 import org.opendaylight.controller.md.sal.dom.api.DOMRpcAvailabilityListener;
15 import org.opendaylight.controller.md.sal.dom.api.DOMRpcIdentifier;
16 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
17 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
18 import org.opendaylight.controller.sal.core.api.model.SchemaService;
19 import org.opendaylight.yangtools.concepts.ListenerRegistration;
20 import org.opendaylight.yangtools.yang.binding.RpcService;
21 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
22 import org.opendaylight.yangtools.yang.common.QNameModule;
23 import org.opendaylight.yangtools.yang.model.api.Module;
24 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
25 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
26 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
27 import org.osgi.service.blueprint.container.ComponentDefinitionException;
28 import org.slf4j.Logger;
29 import org.slf4j.LoggerFactory;
30
31 /**
32  * Factory metadata corresponding to the "rpc-service" element that gets an RPC service implementation from
33  * the RpcProviderRegistry and provides it to the Blueprint container.
34  *
35  * @author Thomas Pantelis
36  */
37 class RpcServiceMetadata extends AbstractDependentComponentFactoryMetadata {
38     private static final Logger LOG = LoggerFactory.getLogger(RpcServiceMetadata.class);
39
40     private final String interfaceName;
41     private volatile Set<SchemaPath> rpcSchemaPaths;
42     private volatile RpcProviderRegistry rpcRegistry;
43     private volatile ListenerRegistration<DOMRpcAvailabilityListener> rpcListenerReg;
44     private volatile Class<RpcService> rpcInterface;
45
46     RpcServiceMetadata(String id, String interfaceName) {
47         super(id);
48         this.interfaceName = interfaceName;
49     }
50
51     @Override
52     @SuppressWarnings("unchecked")
53     public void init(ExtendedBlueprintContainer container) {
54         super.init(container);
55
56         try {
57             Class<?> interfaceClass = container().getBundleContext().getBundle().loadClass(interfaceName);
58             if(!RpcService.class.isAssignableFrom(interfaceClass)) {
59                 throw new ComponentDefinitionException(String.format(
60                         "%s: The specified interface %s is not an RpcService", logName(), interfaceName));
61             }
62
63             rpcInterface = (Class<RpcService>)interfaceClass;
64         } catch(Exception e) {
65             throw new ComponentDefinitionException(String.format("%s: Error obtaining interface class %s",
66                     logName(), interfaceName), e);
67         }
68     }
69
70     @Override
71     protected void startTracking() {
72         // First get the SchemaContext. This will be used to get the RPC SchemaPaths.
73
74         retrieveService("SchemaService", SchemaService.class,
75                 service -> retrievedSchemaContext(((SchemaService)service).getGlobalContext()));
76     }
77
78     private void retrievedSchemaContext(SchemaContext schemaContext) {
79         LOG.debug("{}: retrievedSchemaContext", logName());
80
81         QNameModule moduleName = BindingReflections.getQNameModule(rpcInterface);
82         Module module = schemaContext.findModuleByNamespaceAndRevision(moduleName.getNamespace(), moduleName.getRevision());
83
84         LOG.debug("{}: Got Module: {}", logName(), module);
85
86         rpcSchemaPaths = new HashSet<>();
87         for(RpcDefinition rpcDef : module.getRpcs()) {
88             rpcSchemaPaths.add(rpcDef.getPath());
89         }
90
91         LOG.debug("{}: Got SchemaPaths: {}", logName(), rpcSchemaPaths);
92
93         // First get the DOMRpcService OSGi service. This will be used to register a listener to be notified
94         // when the underlying DOM RPC service is available.
95
96         retrieveService("DOMRpcService", DOMRpcService.class, service -> retrievedDOMRpcService((DOMRpcService)service));
97     }
98
99     private void retrievedDOMRpcService(DOMRpcService domRpcService) {
100         LOG.debug("{}: retrievedDOMRpcService", logName());
101
102         rpcListenerReg = domRpcService.registerRpcListener(new DOMRpcAvailabilityListener() {
103             @Override
104             public void onRpcAvailable(Collection<DOMRpcIdentifier> rpcs) {
105                 onRpcsAvailable(rpcs);
106             }
107
108             @Override
109             public void onRpcUnavailable(Collection<DOMRpcIdentifier> rpcs) {
110             }
111         });
112     }
113
114     protected void onRpcsAvailable(Collection<DOMRpcIdentifier> rpcs) {
115         for(DOMRpcIdentifier identifier: rpcs) {
116             if(rpcSchemaPaths.contains(identifier.getType())) {
117                 LOG.debug("{}: onRpcsAvailable - found SchemaPath {}", logName(), identifier.getType());
118
119                 retrieveService("RpcProviderRegistry", RpcProviderRegistry.class, service -> {
120                     rpcRegistry = (RpcProviderRegistry)service;
121                     setSatisfied();
122                 });
123
124                 break;
125             }
126         }
127     }
128
129     @Override
130     public Object create() throws ComponentDefinitionException {
131         LOG.debug("{}: In create: interfaceName: {}", logName(), interfaceName);
132
133         super.onCreate();
134
135         try {
136             RpcService rpcService = rpcRegistry.getRpcService(rpcInterface);
137
138             LOG.debug("{}: create returning service {}", logName(), rpcService);
139
140             return rpcService;
141         } catch(Exception e) {
142             throw new ComponentDefinitionException("Error getting RPC service for " + interfaceName, e);
143         }
144     }
145
146     @Override
147     public void stopTracking() {
148         super.stopTracking();
149         closeRpcListenerReg();
150     }
151
152     private void closeRpcListenerReg() {
153         if(rpcListenerReg != null) {
154             rpcListenerReg.close();
155             rpcListenerReg = null;
156         }
157     }
158
159     @Override
160     public void destroy(Object instance) {
161         super.destroy(instance);
162         closeRpcListenerReg();
163     }
164
165     @Override
166     public String toString() {
167         return "RpcServiceMetadata [id=" + getId() + ", interfaceName=" + interfaceName + "]";
168     }
169 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.