BUG-7608: Add ActionServiceMetadata and ActionProviderBean
[controller.git] / opendaylight / blueprint / src / main / java / org / opendaylight / controller / blueprint / ext / OpendaylightNamespaceHandler.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 com.google.common.base.Strings;
11 import java.io.IOException;
12 import java.io.StringReader;
13 import java.net.URL;
14 import java.util.Collections;
15 import java.util.Set;
16 import org.apache.aries.blueprint.ComponentDefinitionRegistry;
17 import org.apache.aries.blueprint.NamespaceHandler;
18 import org.apache.aries.blueprint.ParserContext;
19 import org.apache.aries.blueprint.ext.ComponentFactoryMetadata;
20 import org.apache.aries.blueprint.mutable.MutableBeanMetadata;
21 import org.apache.aries.blueprint.mutable.MutableRefMetadata;
22 import org.apache.aries.blueprint.mutable.MutableReferenceMetadata;
23 import org.apache.aries.blueprint.mutable.MutableServiceMetadata;
24 import org.apache.aries.blueprint.mutable.MutableServiceReferenceMetadata;
25 import org.apache.aries.blueprint.mutable.MutableValueMetadata;
26 import org.opendaylight.controller.blueprint.BlueprintContainerRestartService;
27 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
28 import org.opendaylight.controller.md.sal.dom.api.DOMRpcProviderService;
29 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
30 import org.opendaylight.controller.sal.core.api.model.SchemaService;
31 import org.opendaylight.yangtools.util.xml.UntrustedXML;
32 import org.osgi.service.blueprint.container.ComponentDefinitionException;
33 import org.osgi.service.blueprint.reflect.BeanMetadata;
34 import org.osgi.service.blueprint.reflect.ComponentMetadata;
35 import org.osgi.service.blueprint.reflect.Metadata;
36 import org.osgi.service.blueprint.reflect.RefMetadata;
37 import org.osgi.service.blueprint.reflect.ReferenceMetadata;
38 import org.osgi.service.blueprint.reflect.ServiceMetadata;
39 import org.osgi.service.blueprint.reflect.ServiceReferenceMetadata;
40 import org.osgi.service.blueprint.reflect.ValueMetadata;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import org.w3c.dom.Attr;
44 import org.w3c.dom.Element;
45 import org.w3c.dom.Node;
46 import org.w3c.dom.NodeList;
47 import org.xml.sax.InputSource;
48 import org.xml.sax.SAXException;
49
50 /**
51  * The NamespaceHandler for Opendaylight blueprint extensions.
52  *
53  * @author Thomas Pantelis
54  */
55 public final class OpendaylightNamespaceHandler implements NamespaceHandler {
56     public static final String NAMESPACE_1_0_0 = "http://opendaylight.org/xmlns/blueprint/v1.0.0";
57     static final String ROUTED_RPC_REG_CONVERTER_NAME = "org.opendaylight.blueprint.RoutedRpcRegConverter";
58     static final String RPC_PROVIDER_SERVICE_NAME = "org.opendaylight.blueprint.DOMRpcProviderService";
59     static final String RPC_REGISTRY_NAME = "org.opendaylight.blueprint.RpcRegistry";
60     static final String SCHEMA_SERVICE_NAME = "org.opendaylight.blueprint.SchemaService";
61     static final String NOTIFICATION_SERVICE_NAME = "org.opendaylight.blueprint.NotificationService";
62     static final String TYPE_ATTR = "type";
63     static final String UPDATE_STRATEGY_ATTR = "update-strategy";
64
65     private static final Logger LOG = LoggerFactory.getLogger(OpendaylightNamespaceHandler.class);
66     private static final String COMPONENT_PROCESSOR_NAME = ComponentProcessor.class.getName();
67     private static final String RESTART_DEPENDENTS_ON_UPDATES = "restart-dependents-on-updates";
68     private static final String USE_DEFAULT_FOR_REFERENCE_TYPES = "use-default-for-reference-types";
69     private static final String CLUSTERED_APP_CONFIG = "clustered-app-config";
70     private static final String INTERFACE = "interface";
71     private static final String REF_ATTR = "ref";
72     private static final String ID_ATTR = "id";
73     private static final String RPC_SERVICE = "rpc-service";
74     private static final String ACTION_SERVICE = "action-service";
75     private static final String SPECIFIC_SERVICE_REF_LIST = "specific-reference-list";
76     private static final String STATIC_REFERENCE = "static-reference";
77
78     @SuppressWarnings("rawtypes")
79     @Override
80     public Set<Class> getManagedClasses() {
81         return Collections.emptySet();
82     }
83
84     @Override
85     public URL getSchemaLocation(final String namespace) {
86         if (NAMESPACE_1_0_0.equals(namespace)) {
87             URL url = getClass().getResource("/opendaylight-blueprint-ext-1.0.0.xsd");
88             LOG.debug("getSchemaLocation for {} returning URL {}", namespace, url);
89             return url;
90         }
91
92         return null;
93     }
94
95     @Override
96     public Metadata parse(final Element element, final ParserContext context) {
97         LOG.debug("In parse for {}", element);
98
99         if (nodeNameEquals(element, RpcImplementationBean.RPC_IMPLEMENTATION)) {
100             return parseRpcImplementation(element, context);
101         } else if (nodeNameEquals(element, RoutedRpcMetadata.ROUTED_RPC_IMPLEMENTATION)) {
102             return parseRoutedRpcImplementation(element, context);
103         } else if (nodeNameEquals(element, RPC_SERVICE)) {
104             return parseRpcService(element, context);
105         } else if (nodeNameEquals(element, NotificationListenerBean.NOTIFICATION_LISTENER)) {
106             return parseNotificationListener(element, context);
107         } else if (nodeNameEquals(element, CLUSTERED_APP_CONFIG)) {
108             return parseClusteredAppConfig(element, context);
109         } else if (nodeNameEquals(element, SPECIFIC_SERVICE_REF_LIST)) {
110             return parseSpecificReferenceList(element, context);
111         } else if (nodeNameEquals(element, STATIC_REFERENCE)) {
112             return parseStaticReference(element, context);
113         } else if (nodeNameEquals(element, ACTION_SERVICE)) {
114             return parseActionService(element, context);
115         } else if (nodeNameEquals(element, ActionProviderBean.ACTION_PROVIDER)) {
116             return parseActionProvider(element, context);
117         }
118
119         throw new ComponentDefinitionException("Unsupported standalone element: " + element.getNodeName());
120     }
121
122     @Override
123     public ComponentMetadata decorate(final Node node, final ComponentMetadata component, final ParserContext context) {
124         if (node instanceof Attr) {
125             if (nodeNameEquals(node, RESTART_DEPENDENTS_ON_UPDATES)) {
126                 return decorateRestartDependentsOnUpdates((Attr) node, component, context);
127             } else if (nodeNameEquals(node, USE_DEFAULT_FOR_REFERENCE_TYPES)) {
128                 return decorateUseDefaultForReferenceTypes((Attr) node, component, context);
129             } else if (nodeNameEquals(node, TYPE_ATTR)) {
130                 if (component instanceof ServiceReferenceMetadata) {
131                     return decorateServiceReferenceType((Attr) node, component, context);
132                 } else if (component instanceof ServiceMetadata) {
133                     return decorateServiceType((Attr)node, component, context);
134                 }
135
136                 throw new ComponentDefinitionException("Attribute " + node.getNodeName()
137                         + " can only be used on a <reference>, <reference-list> or <service> element");
138             }
139
140             throw new ComponentDefinitionException("Unsupported attribute: " + node.getNodeName());
141         } else {
142             throw new ComponentDefinitionException("Unsupported node type: " + node);
143         }
144     }
145
146     private static ComponentMetadata decorateServiceType(final Attr attr, final ComponentMetadata component,
147             final ParserContext context) {
148         if (!(component instanceof MutableServiceMetadata)) {
149             throw new ComponentDefinitionException("Expected an instanceof MutableServiceMetadata");
150         }
151
152         MutableServiceMetadata service = (MutableServiceMetadata)component;
153
154         LOG.debug("decorateServiceType for {} - adding type property {}", service.getId(), attr.getValue());
155
156         service.addServiceProperty(createValue(context, TYPE_ATTR), createValue(context, attr.getValue()));
157         return component;
158     }
159
160     private static ComponentMetadata decorateServiceReferenceType(final Attr attr, final ComponentMetadata component,
161             final ParserContext context) {
162         if (!(component instanceof MutableServiceReferenceMetadata)) {
163             throw new ComponentDefinitionException("Expected an instanceof MutableServiceReferenceMetadata");
164         }
165
166         // We don't actually need the ComponentProcessor for augmenting the OSGi filter here but we create it
167         // to workaround an issue in Aries where it doesn't use the extended filter unless there's a
168         // Processor or ComponentDefinitionRegistryProcessor registered. This may actually be working as
169         // designed in Aries b/c the extended filter was really added to allow the OSGi filter to be
170         // substituted by a variable via the "cm:property-placeholder" processor. If so, it's a bit funky
171         // but as long as there's at least one processor registered, it correctly uses the extended filter.
172         registerComponentProcessor(context);
173
174         MutableServiceReferenceMetadata serviceRef = (MutableServiceReferenceMetadata)component;
175         String oldFilter = serviceRef.getExtendedFilter() == null ? null :
176             serviceRef.getExtendedFilter().getStringValue();
177
178         String filter;
179         if (Strings.isNullOrEmpty(oldFilter)) {
180             filter = String.format("(type=%s)", attr.getValue());
181         } else {
182             filter = String.format("(&(%s)(type=%s))", oldFilter, attr.getValue());
183         }
184
185         LOG.debug("decorateServiceReferenceType for {} with type {}, old filter: {}, new filter: {}",
186                 serviceRef.getId(), attr.getValue(), oldFilter, filter);
187
188         serviceRef.setExtendedFilter(createValue(context, filter));
189         return component;
190     }
191
192     private static ComponentMetadata decorateRestartDependentsOnUpdates(final Attr attr,
193             final ComponentMetadata component, final ParserContext context) {
194         return enableComponentProcessorProperty(attr, component, context, "restartDependentsOnUpdates");
195     }
196
197     private static ComponentMetadata decorateUseDefaultForReferenceTypes(final Attr attr,
198             final ComponentMetadata component, final ParserContext context) {
199         return enableComponentProcessorProperty(attr, component, context, "useDefaultForReferenceTypes");
200     }
201
202     private static ComponentMetadata enableComponentProcessorProperty(final Attr attr,
203             final ComponentMetadata component, final ParserContext context, final String propertyName) {
204         if (component != null) {
205             throw new ComponentDefinitionException("Attribute " + attr.getNodeName()
206                     + " can only be used on the root <blueprint> element");
207         }
208
209         LOG.debug("{}: {}", propertyName, attr.getValue());
210
211         if (!Boolean.parseBoolean(attr.getValue())) {
212             return component;
213         }
214
215         MutableBeanMetadata metadata = registerComponentProcessor(context);
216         metadata.addProperty(propertyName, createValue(context, "true"));
217
218         return component;
219     }
220
221     private static MutableBeanMetadata registerComponentProcessor(final ParserContext context) {
222         ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry();
223         MutableBeanMetadata metadata = (MutableBeanMetadata) registry.getComponentDefinition(COMPONENT_PROCESSOR_NAME);
224         if (metadata == null) {
225             metadata = context.createMetadata(MutableBeanMetadata.class);
226             metadata.setProcessor(true);
227             metadata.setId(COMPONENT_PROCESSOR_NAME);
228             metadata.setActivation(BeanMetadata.ACTIVATION_EAGER);
229             metadata.setScope(BeanMetadata.SCOPE_SINGLETON);
230             metadata.setRuntimeClass(ComponentProcessor.class);
231             metadata.setDestroyMethod("destroy");
232             metadata.addProperty("bundle", createRef(context, "blueprintBundle"));
233             metadata.addProperty("blueprintContainerRestartService", createServiceRef(context,
234                     BlueprintContainerRestartService.class, null));
235
236             LOG.debug("Registering ComponentProcessor bean: {}", metadata);
237
238             registry.registerComponentDefinition(metadata);
239         }
240
241         return metadata;
242     }
243
244     private static Metadata parseActionProvider(final Element element, final ParserContext context) {
245         registerRpcProviderServiceRefBean(context);
246         registerRpcRegistryServiceRefBean(context);
247         registerSchemaServiceRefBean(context);
248
249         MutableBeanMetadata metadata = context.createMetadata(MutableBeanMetadata.class);
250         metadata.setId(context.generateId());
251         metadata.setScope(BeanMetadata.SCOPE_SINGLETON);
252         metadata.setActivation(ReferenceMetadata.ACTIVATION_EAGER);
253         metadata.setRuntimeClass(ActionProviderBean.class);
254         metadata.setInitMethod("init");
255         metadata.setDestroyMethod("destroy");
256         metadata.addProperty("bundle", createRef(context, "blueprintBundle"));
257         metadata.addProperty("rpcProviderService", createRef(context, RPC_PROVIDER_SERVICE_NAME));
258         metadata.addProperty("rpcRegistry", createRef(context, RPC_REGISTRY_NAME));
259         metadata.addProperty("schemaService", createRef(context, SCHEMA_SERVICE_NAME));
260         metadata.addProperty("interfaceName", createValue(context, element.getAttribute(INTERFACE)));
261
262         if (element.hasAttribute(REF_ATTR)) {
263             metadata.addProperty("implementation", createRef(context, element.getAttribute(REF_ATTR)));
264         }
265
266         LOG.debug("parseActionProvider returning {}", metadata);
267         return metadata;
268     }
269
270     private static Metadata parseRpcImplementation(final Element element, final ParserContext context) {
271         registerRpcRegistryServiceRefBean(context);
272
273         MutableBeanMetadata metadata = context.createMetadata(MutableBeanMetadata.class);
274         metadata.setId(context.generateId());
275         metadata.setScope(BeanMetadata.SCOPE_SINGLETON);
276         metadata.setActivation(ReferenceMetadata.ACTIVATION_EAGER);
277         metadata.setRuntimeClass(RpcImplementationBean.class);
278         metadata.setInitMethod("init");
279         metadata.setDestroyMethod("destroy");
280         metadata.addProperty("bundle", createRef(context, "blueprintBundle"));
281         metadata.addProperty("rpcRegistry", createRef(context, RPC_REGISTRY_NAME));
282         metadata.addProperty("implementation", createRef(context, element.getAttribute(REF_ATTR)));
283
284         if (element.hasAttribute(INTERFACE)) {
285             metadata.addProperty("interfaceName", createValue(context, element.getAttribute(INTERFACE)));
286         }
287
288         LOG.debug("parseRpcImplementation returning {}", metadata);
289         return metadata;
290     }
291
292     private static Metadata parseRoutedRpcImplementation(final Element element, final ParserContext context) {
293         registerRpcRegistryServiceRefBean(context);
294         registerRoutedRpcRegistrationConverter(context);
295
296         ComponentFactoryMetadata metadata = new RoutedRpcMetadata(getId(context, element),
297                 element.getAttribute(INTERFACE), element.getAttribute(REF_ATTR));
298
299         LOG.debug("parseRoutedRpcImplementation returning {}", metadata);
300
301         return metadata;
302     }
303
304     private static Metadata parseActionService(final Element element, final ParserContext context) {
305         ComponentFactoryMetadata metadata = new ActionServiceMetadata(getId(context, element),
306                 element.getAttribute(INTERFACE));
307
308         LOG.debug("parseActionService returning {}", metadata);
309
310         return metadata;
311     }
312
313     private static Metadata parseRpcService(final Element element, final ParserContext context) {
314         ComponentFactoryMetadata metadata = new RpcServiceMetadata(getId(context, element),
315                 element.getAttribute(INTERFACE));
316
317         LOG.debug("parseRpcService returning {}", metadata);
318
319         return metadata;
320     }
321
322     private static void registerRoutedRpcRegistrationConverter(final ParserContext context) {
323         ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry();
324         if (registry.getComponentDefinition(ROUTED_RPC_REG_CONVERTER_NAME) == null) {
325             MutableBeanMetadata metadata = context.createMetadata(MutableBeanMetadata.class);
326             metadata.setId(ROUTED_RPC_REG_CONVERTER_NAME);
327             metadata.setScope(BeanMetadata.SCOPE_SINGLETON);
328             metadata.setActivation(ReferenceMetadata.ACTIVATION_LAZY);
329             metadata.setRuntimeClass(RoutedRpcRegistrationConverter.class);
330             registry.registerTypeConverter(metadata);
331         }
332     }
333
334     private static void registerRpcProviderServiceRefBean(final ParserContext context) {
335         registerRefBean(context, RPC_PROVIDER_SERVICE_NAME, DOMRpcProviderService.class);
336     }
337
338     private static void registerRpcRegistryServiceRefBean(final ParserContext context) {
339         registerRefBean(context, RPC_REGISTRY_NAME, RpcProviderRegistry.class);
340     }
341
342     private static void registerSchemaServiceRefBean(final ParserContext context) {
343         registerRefBean(context, SCHEMA_SERVICE_NAME, SchemaService.class);
344     }
345
346     private static void registerRefBean(final ParserContext context, final String name, final Class<?> clazz) {
347         ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry();
348         if (registry.getComponentDefinition(name) == null) {
349             MutableReferenceMetadata metadata = createServiceRef(context, clazz, null);
350             metadata.setId(name);
351             registry.registerComponentDefinition(metadata);
352         }
353     }
354
355     private static Metadata parseNotificationListener(final Element element, final ParserContext context) {
356         registerNotificationServiceRefBean(context);
357
358         MutableBeanMetadata metadata = context.createMetadata(MutableBeanMetadata.class);
359         metadata.setId(context.generateId());
360         metadata.setScope(BeanMetadata.SCOPE_SINGLETON);
361         metadata.setActivation(ReferenceMetadata.ACTIVATION_EAGER);
362         metadata.setRuntimeClass(NotificationListenerBean.class);
363         metadata.setInitMethod("init");
364         metadata.setDestroyMethod("destroy");
365         metadata.addProperty("bundle", createRef(context, "blueprintBundle"));
366         metadata.addProperty("notificationService", createRef(context, NOTIFICATION_SERVICE_NAME));
367         metadata.addProperty("notificationListener", createRef(context, element.getAttribute(REF_ATTR)));
368
369         LOG.debug("parseNotificationListener returning {}", metadata);
370
371         return metadata;
372     }
373
374     private static void registerNotificationServiceRefBean(final ParserContext context) {
375         ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry();
376         if (registry.getComponentDefinition(NOTIFICATION_SERVICE_NAME) == null) {
377             MutableReferenceMetadata metadata = createServiceRef(context, NotificationService.class, null);
378             metadata.setId(NOTIFICATION_SERVICE_NAME);
379             registry.registerComponentDefinition(metadata);
380         }
381     }
382
383     private static Metadata parseClusteredAppConfig(final Element element, final ParserContext context) {
384         LOG.debug("parseClusteredAppConfig");
385
386         // Find the default-config child element representing the default app config XML, if present.
387         Element defaultConfigElement = null;
388         NodeList children = element.getChildNodes();
389         for (int i = 0; i < children.getLength(); i++) {
390             Node child = children.item(i);
391             if (nodeNameEquals(child, DataStoreAppConfigMetadata.DEFAULT_CONFIG)) {
392                 defaultConfigElement = (Element) child;
393                 break;
394             }
395         }
396
397         Element defaultAppConfigElement = null;
398         if (defaultConfigElement != null) {
399             // Find the CDATA element containing the default app config XML.
400             children = defaultConfigElement.getChildNodes();
401             for (int i = 0; i < children.getLength(); i++) {
402                 Node child = children.item(i);
403                 if (child.getNodeType() == Node.CDATA_SECTION_NODE) {
404                     defaultAppConfigElement = parseXML(DataStoreAppConfigMetadata.DEFAULT_CONFIG,
405                             child.getTextContent());
406                     break;
407                 }
408             }
409         }
410
411         return new DataStoreAppConfigMetadata(getId(context, element), element.getAttribute(
412                 DataStoreAppConfigMetadata.BINDING_CLASS), element.getAttribute(
413                         DataStoreAppConfigMetadata.LIST_KEY_VALUE), element.getAttribute(
414                         DataStoreAppConfigMetadata.DEFAULT_CONFIG_FILE_NAME), parseUpdateStrategy(
415                         element.getAttribute(UPDATE_STRATEGY_ATTR)), defaultAppConfigElement);
416     }
417
418     private static UpdateStrategy parseUpdateStrategy(final String updateStrategyValue) {
419         if (Strings.isNullOrEmpty(updateStrategyValue)
420                 || updateStrategyValue.equalsIgnoreCase(UpdateStrategy.RELOAD.name())) {
421             return UpdateStrategy.RELOAD;
422         } else if (updateStrategyValue.equalsIgnoreCase(UpdateStrategy.NONE.name())) {
423             return UpdateStrategy.NONE;
424         } else {
425             LOG.warn("update-strategy {} not supported, using reload", updateStrategyValue);
426             return UpdateStrategy.RELOAD;
427         }
428     }
429
430     private static Metadata parseSpecificReferenceList(final Element element, final ParserContext context) {
431         ComponentFactoryMetadata metadata = new SpecificReferenceListMetadata(getId(context, element),
432                 element.getAttribute(INTERFACE));
433
434         LOG.debug("parseSpecificReferenceList returning {}", metadata);
435
436         return metadata;
437     }
438
439     private static Metadata parseStaticReference(final Element element, final ParserContext context) {
440         ComponentFactoryMetadata metadata = new StaticReferenceMetadata(getId(context, element),
441                 element.getAttribute(INTERFACE));
442
443         LOG.debug("parseStaticReference returning {}", metadata);
444
445         return metadata;
446     }
447
448     private static Element parseXML(final String name, final String xml) {
449         try {
450             return UntrustedXML.newDocumentBuilder().parse(new InputSource(new StringReader(xml))).getDocumentElement();
451         } catch (SAXException | IOException e) {
452             throw new ComponentDefinitionException(String.format("Error %s parsing XML: %s", name, xml), e);
453         }
454     }
455
456     private static ValueMetadata createValue(final ParserContext context, final String value) {
457         MutableValueMetadata metadata = context.createMetadata(MutableValueMetadata.class);
458         metadata.setStringValue(value);
459         return metadata;
460     }
461
462     private static MutableReferenceMetadata createServiceRef(final ParserContext context, final Class<?> cls,
463             final String filter) {
464         MutableReferenceMetadata metadata = context.createMetadata(MutableReferenceMetadata.class);
465         metadata.setRuntimeInterface(cls);
466         metadata.setInterface(cls.getName());
467         metadata.setActivation(ReferenceMetadata.ACTIVATION_EAGER);
468         metadata.setAvailability(ReferenceMetadata.AVAILABILITY_MANDATORY);
469
470         if (filter != null) {
471             metadata.setFilter(filter);
472         }
473
474         return metadata;
475     }
476
477     private static RefMetadata createRef(final ParserContext context, final String id) {
478         MutableRefMetadata metadata = context.createMetadata(MutableRefMetadata.class);
479         metadata.setComponentId(id);
480         return metadata;
481     }
482
483     private static String getId(final ParserContext context, final Element element) {
484         if (element.hasAttribute(ID_ATTR)) {
485             return element.getAttribute(ID_ATTR);
486         } else {
487             return context.generateId();
488         }
489     }
490
491     private static boolean nodeNameEquals(final Node node, final String name) {
492         return name.equals(node.getNodeName()) || name.equals(node.getLocalName());
493     }
494 }