X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fblueprint%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fblueprint%2Fext%2FOpendaylightNamespaceHandler.java;h=7ce521e93f0ee8bfdd2fdac58e79ed24014c68b1;hb=refs%2Fchanges%2F76%2F69876%2F11;hp=976eb7b9d5c1912c28b72720b822db3bbb51f45a;hpb=67ff0fc78b2933b8b4f5a8544c7639499824e622;p=controller.git diff --git a/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/OpendaylightNamespaceHandler.java b/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/OpendaylightNamespaceHandler.java index 976eb7b9d5..7ce521e93f 100644 --- a/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/OpendaylightNamespaceHandler.java +++ b/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/OpendaylightNamespaceHandler.java @@ -8,13 +8,12 @@ package org.opendaylight.controller.blueprint.ext; import com.google.common.base.Strings; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.io.IOException; import java.io.StringReader; import java.net.URL; import java.util.Collections; import java.util.Set; -import javax.xml.parsers.DocumentBuilderFactory; -import javax.xml.parsers.ParserConfigurationException; import org.apache.aries.blueprint.ComponentDefinitionRegistry; import org.apache.aries.blueprint.NamespaceHandler; import org.apache.aries.blueprint.ParserContext; @@ -27,7 +26,10 @@ import org.apache.aries.blueprint.mutable.MutableServiceReferenceMetadata; import org.apache.aries.blueprint.mutable.MutableValueMetadata; import org.opendaylight.controller.blueprint.BlueprintContainerRestartService; import org.opendaylight.controller.md.sal.binding.api.NotificationService; +import org.opendaylight.controller.md.sal.dom.api.DOMRpcProviderService; import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry; +import org.opendaylight.mdsal.dom.api.DOMSchemaService; +import org.opendaylight.yangtools.util.xml.UntrustedXML; import org.osgi.service.blueprint.container.ComponentDefinitionException; import org.osgi.service.blueprint.reflect.BeanMetadata; import org.osgi.service.blueprint.reflect.ComponentMetadata; @@ -51,10 +53,12 @@ import org.xml.sax.SAXException; * * @author Thomas Pantelis */ -public class OpendaylightNamespaceHandler implements NamespaceHandler { +public final class OpendaylightNamespaceHandler implements NamespaceHandler { public static final String NAMESPACE_1_0_0 = "http://opendaylight.org/xmlns/blueprint/v1.0.0"; static final String ROUTED_RPC_REG_CONVERTER_NAME = "org.opendaylight.blueprint.RoutedRpcRegConverter"; + static final String RPC_PROVIDER_SERVICE_NAME = "org.opendaylight.blueprint.DOMRpcProviderService"; static final String RPC_REGISTRY_NAME = "org.opendaylight.blueprint.RpcRegistry"; + static final String SCHEMA_SERVICE_NAME = "org.opendaylight.blueprint.SchemaService"; static final String NOTIFICATION_SERVICE_NAME = "org.opendaylight.blueprint.NotificationService"; static final String TYPE_ATTR = "type"; static final String UPDATE_STRATEGY_ATTR = "update-strategy"; @@ -68,6 +72,7 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { private static final String REF_ATTR = "ref"; private static final String ID_ATTR = "id"; private static final String RPC_SERVICE = "rpc-service"; + private static final String ACTION_SERVICE = "action-service"; private static final String SPECIFIC_SERVICE_REF_LIST = "specific-reference-list"; private static final String STATIC_REFERENCE = "static-reference"; @@ -78,7 +83,7 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } @Override - public URL getSchemaLocation(String namespace) { + public URL getSchemaLocation(final String namespace) { if (NAMESPACE_1_0_0.equals(namespace)) { URL url = getClass().getResource("/opendaylight-blueprint-ext-1.0.0.xsd"); LOG.debug("getSchemaLocation for {} returning URL {}", namespace, url); @@ -89,7 +94,7 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } @Override - public Metadata parse(Element element, ParserContext context) { + public Metadata parse(final Element element, final ParserContext context) { LOG.debug("In parse for {}", element); if (nodeNameEquals(element, RpcImplementationBean.RPC_IMPLEMENTATION)) { @@ -106,13 +111,17 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return parseSpecificReferenceList(element, context); } else if (nodeNameEquals(element, STATIC_REFERENCE)) { return parseStaticReference(element, context); + } else if (nodeNameEquals(element, ACTION_SERVICE)) { + return parseActionService(element, context); + } else if (nodeNameEquals(element, ActionProviderBean.ACTION_PROVIDER)) { + return parseActionProvider(element, context); } throw new ComponentDefinitionException("Unsupported standalone element: " + element.getNodeName()); } @Override - public ComponentMetadata decorate(Node node, ComponentMetadata component, ParserContext context) { + public ComponentMetadata decorate(final Node node, final ComponentMetadata component, final ParserContext context) { if (node instanceof Attr) { if (nodeNameEquals(node, RESTART_DEPENDENTS_ON_UPDATES)) { return decorateRestartDependentsOnUpdates((Attr) node, component, context); @@ -135,7 +144,8 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } } - private ComponentMetadata decorateServiceType(Attr attr, ComponentMetadata component, ParserContext context) { + private static ComponentMetadata decorateServiceType(final Attr attr, final ComponentMetadata component, + final ParserContext context) { if (!(component instanceof MutableServiceMetadata)) { throw new ComponentDefinitionException("Expected an instanceof MutableServiceMetadata"); } @@ -148,8 +158,9 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return component; } - private ComponentMetadata decorateServiceReferenceType(Attr attr, ComponentMetadata component, - ParserContext context) { + @SuppressFBWarnings(value = "NP_NULL_PARAM_DEREF", justification = "Unrecognised NullableDecl") + private static ComponentMetadata decorateServiceReferenceType(final Attr attr, final ComponentMetadata component, + final ParserContext context) { if (!(component instanceof MutableServiceReferenceMetadata)) { throw new ComponentDefinitionException("Expected an instanceof MutableServiceReferenceMetadata"); } @@ -180,18 +191,18 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return component; } - private static ComponentMetadata decorateRestartDependentsOnUpdates(Attr attr, ComponentMetadata component, - ParserContext context) { + private static ComponentMetadata decorateRestartDependentsOnUpdates(final Attr attr, + final ComponentMetadata component, final ParserContext context) { return enableComponentProcessorProperty(attr, component, context, "restartDependentsOnUpdates"); } - private static ComponentMetadata decorateUseDefaultForReferenceTypes(Attr attr, ComponentMetadata component, - ParserContext context) { + private static ComponentMetadata decorateUseDefaultForReferenceTypes(final Attr attr, + final ComponentMetadata component, final ParserContext context) { return enableComponentProcessorProperty(attr, component, context, "useDefaultForReferenceTypes"); } - private static ComponentMetadata enableComponentProcessorProperty(Attr attr, ComponentMetadata component, - ParserContext context, String propertyName) { + private static ComponentMetadata enableComponentProcessorProperty(final Attr attr, + final ComponentMetadata component, final ParserContext context, final String propertyName) { if (component != null) { throw new ComponentDefinitionException("Attribute " + attr.getNodeName() + " can only be used on the root element"); @@ -209,18 +220,13 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return component; } - private static MutableBeanMetadata registerComponentProcessor(ParserContext context) { + private static MutableBeanMetadata registerComponentProcessor(final ParserContext context) { ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry(); MutableBeanMetadata metadata = (MutableBeanMetadata) registry.getComponentDefinition(COMPONENT_PROCESSOR_NAME); if (metadata == null) { - metadata = context.createMetadata(MutableBeanMetadata.class); + metadata = createBeanMetadata(context, COMPONENT_PROCESSOR_NAME, ComponentProcessor.class, false, true); metadata.setProcessor(true); - metadata.setId(COMPONENT_PROCESSOR_NAME); - metadata.setActivation(BeanMetadata.ACTIVATION_EAGER); - metadata.setScope(BeanMetadata.SCOPE_SINGLETON); - metadata.setRuntimeClass(ComponentProcessor.class); - metadata.setDestroyMethod("destroy"); - metadata.addProperty("bundle", createRef(context, "blueprintBundle")); + addBlueprintBundleRefProperty(context, metadata); metadata.addProperty("blueprintContainerRestartService", createServiceRef(context, BlueprintContainerRestartService.class, null)); @@ -232,17 +238,34 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return metadata; } - private Metadata parseRpcImplementation(Element element, ParserContext context) { + private static Metadata parseActionProvider(final Element element, final ParserContext context) { + registerRpcProviderServiceRefBean(context); registerRpcRegistryServiceRefBean(context); + registerSchemaServiceRefBean(context); - MutableBeanMetadata metadata = context.createMetadata(MutableBeanMetadata.class); - metadata.setId(context.generateId()); - metadata.setScope(BeanMetadata.SCOPE_SINGLETON); - metadata.setActivation(ReferenceMetadata.ACTIVATION_EAGER); - metadata.setRuntimeClass(RpcImplementationBean.class); - metadata.setInitMethod("init"); - metadata.setDestroyMethod("destroy"); - metadata.addProperty("bundle", createRef(context, "blueprintBundle")); + MutableBeanMetadata metadata = createBeanMetadata(context, context.generateId(), ActionProviderBean.class, + true, true); + addBlueprintBundleRefProperty(context, metadata); + metadata.addProperty("rpcProviderService", createRef(context, RPC_PROVIDER_SERVICE_NAME)); + metadata.addProperty("rpcRegistry", createRef(context, RPC_REGISTRY_NAME)); + metadata.addProperty("schemaService", createRef(context, SCHEMA_SERVICE_NAME)); + metadata.addProperty("interfaceName", createValue(context, element.getAttribute(INTERFACE))); + + if (element.hasAttribute(REF_ATTR)) { + metadata.addProperty("implementation", createRef(context, element.getAttribute(REF_ATTR))); + } + + LOG.debug("parseActionProvider returning {}", metadata); + return metadata; + } + + + private static Metadata parseRpcImplementation(final Element element, final ParserContext context) { + registerRpcRegistryServiceRefBean(context); + + MutableBeanMetadata metadata = createBeanMetadata(context, context.generateId(), RpcImplementationBean.class, + true, true); + addBlueprintBundleRefProperty(context, metadata); metadata.addProperty("rpcRegistry", createRef(context, RPC_REGISTRY_NAME)); metadata.addProperty("implementation", createRef(context, element.getAttribute(REF_ATTR))); @@ -250,12 +273,11 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { metadata.addProperty("interfaceName", createValue(context, element.getAttribute(INTERFACE))); } - LOG.debug("parseAddRpcImplementation returning {}", metadata); - + LOG.debug("parseRpcImplementation returning {}", metadata); return metadata; } - private Metadata parseRoutedRpcImplementation(Element element, ParserContext context) { + private static Metadata parseRoutedRpcImplementation(final Element element, final ParserContext context) { registerRpcRegistryServiceRefBean(context); registerRoutedRpcRegistrationConverter(context); @@ -267,7 +289,16 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return metadata; } - private Metadata parseRpcService(Element element, ParserContext context) { + private static Metadata parseActionService(final Element element, final ParserContext context) { + ComponentFactoryMetadata metadata = new ActionServiceMetadata(getId(context, element), + element.getAttribute(INTERFACE)); + + LOG.debug("parseActionService returning {}", metadata); + + return metadata; + } + + private static Metadata parseRpcService(final Element element, final ParserContext context) { ComponentFactoryMetadata metadata = new RpcServiceMetadata(getId(context, element), element.getAttribute(INTERFACE)); @@ -276,38 +307,43 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return metadata; } - private void registerRoutedRpcRegistrationConverter(ParserContext context) { + private static void registerRoutedRpcRegistrationConverter(final ParserContext context) { ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry(); if (registry.getComponentDefinition(ROUTED_RPC_REG_CONVERTER_NAME) == null) { - MutableBeanMetadata metadata = context.createMetadata(MutableBeanMetadata.class); - metadata.setId(ROUTED_RPC_REG_CONVERTER_NAME); - metadata.setScope(BeanMetadata.SCOPE_SINGLETON); + MutableBeanMetadata metadata = createBeanMetadata(context, ROUTED_RPC_REG_CONVERTER_NAME, + RoutedRpcRegistrationConverter.class, false, false); metadata.setActivation(ReferenceMetadata.ACTIVATION_LAZY); - metadata.setRuntimeClass(RoutedRpcRegistrationConverter.class); registry.registerTypeConverter(metadata); } } - private void registerRpcRegistryServiceRefBean(ParserContext context) { + private static void registerRpcProviderServiceRefBean(final ParserContext context) { + registerRefBean(context, RPC_PROVIDER_SERVICE_NAME, DOMRpcProviderService.class); + } + + private static void registerRpcRegistryServiceRefBean(final ParserContext context) { + registerRefBean(context, RPC_REGISTRY_NAME, RpcProviderRegistry.class); + } + + private static void registerSchemaServiceRefBean(final ParserContext context) { + registerRefBean(context, SCHEMA_SERVICE_NAME, DOMSchemaService.class); + } + + private static void registerRefBean(final ParserContext context, final String name, final Class clazz) { ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry(); - if (registry.getComponentDefinition(RPC_REGISTRY_NAME) == null) { - MutableReferenceMetadata metadata = createServiceRef(context, RpcProviderRegistry.class, null); - metadata.setId(RPC_REGISTRY_NAME); + if (registry.getComponentDefinition(name) == null) { + MutableReferenceMetadata metadata = createServiceRef(context, clazz, null); + metadata.setId(name); registry.registerComponentDefinition(metadata); } } - private Metadata parseNotificationListener(Element element, ParserContext context) { + private static Metadata parseNotificationListener(final Element element, final ParserContext context) { registerNotificationServiceRefBean(context); - MutableBeanMetadata metadata = context.createMetadata(MutableBeanMetadata.class); - metadata.setId(context.generateId()); - metadata.setScope(BeanMetadata.SCOPE_SINGLETON); - metadata.setActivation(ReferenceMetadata.ACTIVATION_EAGER); - metadata.setRuntimeClass(NotificationListenerBean.class); - metadata.setInitMethod("init"); - metadata.setDestroyMethod("destroy"); - metadata.addProperty("bundle", createRef(context, "blueprintBundle")); + MutableBeanMetadata metadata = createBeanMetadata(context, context.generateId(), NotificationListenerBean.class, + true, true); + addBlueprintBundleRefProperty(context, metadata); metadata.addProperty("notificationService", createRef(context, NOTIFICATION_SERVICE_NAME)); metadata.addProperty("notificationListener", createRef(context, element.getAttribute(REF_ATTR))); @@ -316,7 +352,7 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return metadata; } - private void registerNotificationServiceRefBean(ParserContext context) { + private static void registerNotificationServiceRefBean(final ParserContext context) { ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry(); if (registry.getComponentDefinition(NOTIFICATION_SERVICE_NAME) == null) { MutableReferenceMetadata metadata = createServiceRef(context, NotificationService.class, null); @@ -325,7 +361,7 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } } - private Metadata parseClusteredAppConfig(Element element, ParserContext context) { + private static Metadata parseClusteredAppConfig(final Element element, final ParserContext context) { LOG.debug("parseClusteredAppConfig"); // Find the default-config child element representing the default app config XML, if present. @@ -360,7 +396,7 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { element.getAttribute(UPDATE_STRATEGY_ATTR)), defaultAppConfigElement); } - private UpdateStrategy parseUpdateStrategy(String updateStrategyValue) { + private static UpdateStrategy parseUpdateStrategy(final String updateStrategyValue) { if (Strings.isNullOrEmpty(updateStrategyValue) || updateStrategyValue.equalsIgnoreCase(UpdateStrategy.RELOAD.name())) { return UpdateStrategy.RELOAD; @@ -372,7 +408,7 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } } - private Metadata parseSpecificReferenceList(Element element, ParserContext context) { + private static Metadata parseSpecificReferenceList(final Element element, final ParserContext context) { ComponentFactoryMetadata metadata = new SpecificReferenceListMetadata(getId(context, element), element.getAttribute(INTERFACE)); @@ -381,7 +417,7 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return metadata; } - private Metadata parseStaticReference(Element element, ParserContext context) { + private static Metadata parseStaticReference(final Element element, final ParserContext context) { ComponentFactoryMetadata metadata = new StaticReferenceMetadata(getId(context, element), element.getAttribute(INTERFACE)); @@ -390,28 +426,22 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return metadata; } - private Element parseXML(String name, String xml) { - DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance(); - builderFactory.setNamespaceAware(true); - builderFactory.setCoalescing(true); - builderFactory.setIgnoringElementContentWhitespace(true); - builderFactory.setIgnoringComments(true); - + private static Element parseXML(final String name, final String xml) { try { - return builderFactory.newDocumentBuilder().parse(new InputSource( - new StringReader(xml))).getDocumentElement(); - } catch (SAXException | IOException | ParserConfigurationException e) { + return UntrustedXML.newDocumentBuilder().parse(new InputSource(new StringReader(xml))).getDocumentElement(); + } catch (SAXException | IOException e) { throw new ComponentDefinitionException(String.format("Error %s parsing XML: %s", name, xml), e); } } - private static ValueMetadata createValue(ParserContext context, String value) { + private static ValueMetadata createValue(final ParserContext context, final String value) { MutableValueMetadata metadata = context.createMetadata(MutableValueMetadata.class); metadata.setStringValue(value); return metadata; } - private static MutableReferenceMetadata createServiceRef(ParserContext context, Class cls, String filter) { + private static MutableReferenceMetadata createServiceRef(final ParserContext context, final Class cls, + final String filter) { MutableReferenceMetadata metadata = context.createMetadata(MutableReferenceMetadata.class); metadata.setRuntimeInterface(cls); metadata.setInterface(cls.getName()); @@ -425,13 +455,13 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return metadata; } - private static RefMetadata createRef(ParserContext context, String id) { + private static RefMetadata createRef(final ParserContext context, final String id) { MutableRefMetadata metadata = context.createMetadata(MutableRefMetadata.class); metadata.setComponentId(id); return metadata; } - private static String getId(ParserContext context, Element element) { + private static String getId(final ParserContext context, final Element element) { if (element.hasAttribute(ID_ATTR)) { return element.getAttribute(ID_ATTR); } else { @@ -439,7 +469,30 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } } - private static boolean nodeNameEquals(Node node, String name) { + private static boolean nodeNameEquals(final Node node, final String name) { return name.equals(node.getNodeName()) || name.equals(node.getLocalName()); } + + private static void addBlueprintBundleRefProperty(final ParserContext context, final MutableBeanMetadata metadata) { + metadata.addProperty("bundle", createRef(context, "blueprintBundle")); + } + + private static MutableBeanMetadata createBeanMetadata(final ParserContext context, final String id, + final Class runtimeClass, final boolean initMethod, final boolean destroyMethod) { + MutableBeanMetadata metadata = context.createMetadata(MutableBeanMetadata.class); + metadata.setId(id); + metadata.setScope(BeanMetadata.SCOPE_SINGLETON); + metadata.setActivation(ReferenceMetadata.ACTIVATION_EAGER); + metadata.setRuntimeClass(runtimeClass); + + if (initMethod) { + metadata.setInitMethod("init"); + } + + if (destroyMethod) { + metadata.setDestroyMethod("destroy"); + } + + return metadata; + } }