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=371b7efecdec1fa6e67f700acce75e10aa4beebd;hb=HEAD;hp=ab9e216d036d52628fcaa10d7ef257e41616a518;hpb=b9040c52d74cf4c16aeb16774f2c1056589fb203;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 ab9e216d03..371b7efecd 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,15 +8,13 @@ package org.opendaylight.controller.blueprint.ext; import com.google.common.base.Strings; +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 org.apache.aries.blueprint.ComponentDefinitionRegistry; import org.apache.aries.blueprint.NamespaceHandler; import org.apache.aries.blueprint.ParserContext; -import org.apache.aries.blueprint.ext.ComponentFactoryMetadata; import org.apache.aries.blueprint.mutable.MutableBeanMetadata; import org.apache.aries.blueprint.mutable.MutableRefMetadata; import org.apache.aries.blueprint.mutable.MutableReferenceMetadata; @@ -24,8 +22,7 @@ import org.apache.aries.blueprint.mutable.MutableServiceMetadata; 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.sal.binding.api.RpcProviderRegistry; +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; @@ -42,39 +39,34 @@ import org.w3c.dom.Element; import org.w3c.dom.Node; import org.w3c.dom.NodeList; import org.xml.sax.InputSource; +import org.xml.sax.SAXException; /** * The NamespaceHandler for Opendaylight blueprint extensions. * * @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_REGISTRY_NAME = "org.opendaylight.blueprint.RpcRegistry"; - static final String NOTIFICATION_SERVICE_NAME = "org.opendaylight.blueprint.NotificationService"; - static final String TYPE_ATTR = "type"; private static final Logger LOG = LoggerFactory.getLogger(OpendaylightNamespaceHandler.class); + private static final String TYPE_ATTR = "type"; + private static final String UPDATE_STRATEGY_ATTR = "update-strategy"; private static final String COMPONENT_PROCESSOR_NAME = ComponentProcessor.class.getName(); private static final String RESTART_DEPENDENTS_ON_UPDATES = "restart-dependents-on-updates"; private static final String USE_DEFAULT_FOR_REFERENCE_TYPES = "use-default-for-reference-types"; private static final String CLUSTERED_APP_CONFIG = "clustered-app-config"; - private static final String INTERFACE = "interface"; - 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 SPECIFIC_SERVICE_REF_LIST = "specific-reference-list"; @SuppressWarnings("rawtypes") @Override public Set getManagedClasses() { - return Collections.emptySet(); + return Set.of(); } @Override - public URL getSchemaLocation(String namespace) { - if(NAMESPACE_1_0_0.equals(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); return url; @@ -84,42 +76,32 @@ 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)) { - return parseRpcImplementation(element, context); - } else if (nodeNameEquals(element, RoutedRpcMetadata.ROUTED_RPC_IMPLEMENTATION)) { - return parseRoutedRpcImplementation(element, context); - } else if (nodeNameEquals(element, RPC_SERVICE)) { - return parseRpcService(element, context); - } else if (nodeNameEquals(element, NotificationListenerBean.NOTIFICATION_LISTENER)) { - return parseNotificationListener(element, context); - } else if (nodeNameEquals(element, CLUSTERED_APP_CONFIG)) { + if (nodeNameEquals(element, CLUSTERED_APP_CONFIG)) { return parseClusteredAppConfig(element, context); - } else if (nodeNameEquals(element, SPECIFIC_SERVICE_REF_LIST)) { - return parseSpecificReferenceList(element, context); } throw new ComponentDefinitionException("Unsupported standalone element: " + element.getNodeName()); } @Override - public ComponentMetadata decorate(Node node, ComponentMetadata component, ParserContext context) { - if(node instanceof Attr) { + 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); + return decorateRestartDependentsOnUpdates((Attr) node, component, context); } else if (nodeNameEquals(node, USE_DEFAULT_FOR_REFERENCE_TYPES)) { - return decorateUseDefaultForReferenceTypes((Attr)node, component, context); + return decorateUseDefaultForReferenceTypes((Attr) node, component, context); } else if (nodeNameEquals(node, TYPE_ATTR)) { - if(component instanceof ServiceReferenceMetadata) { - return decorateServiceReferenceType((Attr)node, component, context); - } else if(component instanceof ServiceMetadata) { + if (component instanceof ServiceReferenceMetadata) { + return decorateServiceReferenceType((Attr) node, component, context); + } else if (component instanceof ServiceMetadata) { return decorateServiceType((Attr)node, component, context); } - throw new ComponentDefinitionException("Attribute " + node.getNodeName() + - " can only be used on a , or element"); + throw new ComponentDefinitionException("Attribute " + node.getNodeName() + + " can only be used on a , or element"); } throw new ComponentDefinitionException("Unsupported attribute: " + node.getNodeName()); @@ -128,20 +110,20 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } } - private ComponentMetadata decorateServiceType(Attr attr, ComponentMetadata component, ParserContext context) { - if (!(component instanceof MutableServiceMetadata)) { + private static ComponentMetadata decorateServiceType(final Attr attr, final ComponentMetadata component, + final ParserContext context) { + if (!(component instanceof MutableServiceMetadata service)) { throw new ComponentDefinitionException("Expected an instanceof MutableServiceMetadata"); } - MutableServiceMetadata service = (MutableServiceMetadata)component; - LOG.debug("decorateServiceType for {} - adding type property {}", service.getId(), attr.getValue()); service.addServiceProperty(createValue(context, TYPE_ATTR), createValue(context, attr.getValue())); return component; } - private ComponentMetadata decorateServiceReferenceType(Attr attr, ComponentMetadata component, ParserContext context) { + private static ComponentMetadata decorateServiceReferenceType(final Attr attr, final ComponentMetadata component, + final ParserContext context) { if (!(component instanceof MutableServiceReferenceMetadata)) { throw new ComponentDefinitionException("Expected an instanceof MutableServiceReferenceMetadata"); } @@ -159,7 +141,7 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { serviceRef.getExtendedFilter().getStringValue(); String filter; - if(Strings.isNullOrEmpty(oldFilter)) { + if (Strings.isNullOrEmpty(oldFilter)) { filter = String.format("(type=%s)", attr.getValue()); } else { filter = String.format("(&(%s)(type=%s))", oldFilter, attr.getValue()); @@ -172,26 +154,26 @@ 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) { - if(component != null) { - throw new ComponentDefinitionException("Attribute " + attr.getNodeName() + - " can only be used on the root element"); + 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"); } - LOG.debug("{}: {}", propertyName, attr.getValue()); + LOG.debug("Property {} = {}", propertyName, attr.getValue()); - if(!Boolean.parseBoolean(attr.getValue())) { + if (!Boolean.parseBoolean(attr.getValue())) { return component; } @@ -201,18 +183,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); + if (metadata == null) { + 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)); @@ -224,121 +201,29 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return metadata; } - private Metadata parseRpcImplementation(Element element, ParserContext context) { - registerRpcRegistryServiceRefBean(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")); - metadata.addProperty("rpcRegistry", createRef(context, RPC_REGISTRY_NAME)); - metadata.addProperty("implementation", createRef(context, element.getAttribute(REF_ATTR))); - - if(element.hasAttribute(INTERFACE)) { - metadata.addProperty("interfaceName", createValue(context, element.getAttribute(INTERFACE))); - } - - LOG.debug("parseAddRpcImplementation returning {}", metadata); - - return metadata; - } - - private Metadata parseRoutedRpcImplementation(Element element, ParserContext context) { - registerRpcRegistryServiceRefBean(context); - registerRoutedRpcRegistrationConverter(context); - - ComponentFactoryMetadata metadata = new RoutedRpcMetadata(getId(context, element), - element.getAttribute(INTERFACE), element.getAttribute(REF_ATTR)); - - LOG.debug("parseRoutedRpcImplementation returning {}", metadata); - - return metadata; - } - - private Metadata parseRpcService(Element element, ParserContext context) { - ComponentFactoryMetadata metadata = new RpcServiceMetadata(getId(context, element), - element.getAttribute(INTERFACE)); - - LOG.debug("parseRpcService returning {}", metadata); - - return metadata; - } - - private void registerRoutedRpcRegistrationConverter(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); - metadata.setActivation(ReferenceMetadata.ACTIVATION_LAZY); - metadata.setRuntimeClass(RoutedRpcRegistrationConverter.class); - registry.registerTypeConverter(metadata); - } - } - - private void registerRpcRegistryServiceRefBean(ParserContext context) { - ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry(); - if(registry.getComponentDefinition(RPC_REGISTRY_NAME) == null) { - MutableReferenceMetadata metadata = createServiceRef(context, RpcProviderRegistry.class, null); - metadata.setId(RPC_REGISTRY_NAME); - registry.registerComponentDefinition(metadata); - } - } - - private Metadata parseNotificationListener(Element element, 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")); - metadata.addProperty("notificationService", createRef(context, NOTIFICATION_SERVICE_NAME)); - metadata.addProperty("notificationListener", createRef(context, element.getAttribute(REF_ATTR))); - - LOG.debug("parseNotificationListener returning {}", metadata); - - return metadata; - } - - private void registerNotificationServiceRefBean(ParserContext context) { - ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry(); - if(registry.getComponentDefinition(NOTIFICATION_SERVICE_NAME) == null) { - MutableReferenceMetadata metadata = createServiceRef(context, NotificationService.class, null); - metadata.setId(NOTIFICATION_SERVICE_NAME); - registry.registerComponentDefinition(metadata); - } - } - - 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. Element defaultConfigElement = null; NodeList children = element.getChildNodes(); - for(int i = 0; i < children.getLength(); i++) { + for (int i = 0; i < children.getLength(); i++) { Node child = children.item(i); - if(nodeNameEquals(child, DataStoreAppConfigMetadata.DEFAULT_CONFIG)) { + if (nodeNameEquals(child, DataStoreAppConfigMetadata.DEFAULT_CONFIG)) { defaultConfigElement = (Element) child; break; } } Element defaultAppConfigElement = null; - if(defaultConfigElement != null) { + if (defaultConfigElement != null) { // Find the CDATA element containing the default app config XML. children = defaultConfigElement.getChildNodes(); - for(int i = 0; i < children.getLength(); i++) { + for (int i = 0; i < children.getLength(); i++) { Node child = children.item(i); - if(child.getNodeType() == Node.CDATA_SECTION_NODE) { - defaultAppConfigElement = parseXML(DataStoreAppConfigMetadata.DEFAULT_CONFIG, child.getTextContent()); + if (child.getNodeType() == Node.CDATA_SECTION_NODE) { + defaultAppConfigElement = parseXML(DataStoreAppConfigMetadata.DEFAULT_CONFIG, + child.getTextContent()); break; } } @@ -346,67 +231,90 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return new DataStoreAppConfigMetadata(getId(context, element), element.getAttribute( DataStoreAppConfigMetadata.BINDING_CLASS), element.getAttribute( - DataStoreAppConfigMetadata.LIST_KEY_VALUE), defaultAppConfigElement); + DataStoreAppConfigMetadata.LIST_KEY_VALUE), element.getAttribute( + DataStoreAppConfigMetadata.DEFAULT_CONFIG_FILE_NAME), parseUpdateStrategy( + element.getAttribute(UPDATE_STRATEGY_ATTR)), defaultAppConfigElement); } - private Metadata parseSpecificReferenceList(Element element, ParserContext context) { - ComponentFactoryMetadata metadata = new SpecificReferenceListMetadata(getId(context, element), - element.getAttribute(INTERFACE)); - - LOG.debug("parseSpecificReferenceList returning {}", metadata); - - return metadata; + private static UpdateStrategy parseUpdateStrategy(final String updateStrategyValue) { + if (Strings.isNullOrEmpty(updateStrategyValue) + || updateStrategyValue.equalsIgnoreCase(UpdateStrategy.RELOAD.name())) { + return UpdateStrategy.RELOAD; + } else if (updateStrategyValue.equalsIgnoreCase(UpdateStrategy.NONE.name())) { + return UpdateStrategy.NONE; + } else { + LOG.warn("update-strategy {} not supported, using reload", updateStrategyValue); + return UpdateStrategy.RELOAD; + } } - 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(Exception e) { - throw new ComponentDefinitionException(String.format("Error %s parsing XML: %s", name, xml)); + 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) { - MutableValueMetadata m = context.createMetadata(MutableValueMetadata.class); - m.setStringValue(value); - return m; + 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) { - MutableReferenceMetadata m = context.createMetadata(MutableReferenceMetadata.class); - m.setRuntimeInterface(cls); - m.setInterface(cls.getName()); - m.setActivation(ReferenceMetadata.ACTIVATION_EAGER); - m.setAvailability(ReferenceMetadata.AVAILABILITY_MANDATORY); + 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()); + metadata.setActivation(ReferenceMetadata.ACTIVATION_EAGER); + metadata.setAvailability(ReferenceMetadata.AVAILABILITY_MANDATORY); - if(filter != null) { - m.setFilter(filter); + if (filter != null) { + metadata.setFilter(filter); } - return m; + 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) { - if(element.hasAttribute(ID_ATTR)) { + private static String getId(final ParserContext context, final Element element) { + if (element.hasAttribute(ID_ATTR)) { return element.getAttribute(ID_ATTR); } else { return context.generateId(); } } - 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; + } }