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

©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.