X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fblueprint%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fblueprint%2Fext%2FOpendaylightNamespaceHandler.java;h=20f29ca7d04bd34baa1be9b0eaa62a606b9cddbe;hp=89bea931825b0b14f466501d4204b087ce67209e;hb=88330d2f3ff048ab4e2e6f348ec3ea56e4c02cd4;hpb=36de1fd1c214d98ae97e6d7725f323dd01e34977 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 89bea93182..20f29ca7d0 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 @@ -7,41 +7,73 @@ */ 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 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; +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.md.sal.dom.api.DOMRpcProviderService; +import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry; +import org.opendaylight.controller.sal.core.api.model.SchemaService; +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; import org.osgi.service.blueprint.reflect.Metadata; import org.osgi.service.blueprint.reflect.RefMetadata; import org.osgi.service.blueprint.reflect.ReferenceMetadata; +import org.osgi.service.blueprint.reflect.ServiceMetadata; +import org.osgi.service.blueprint.reflect.ServiceReferenceMetadata; import org.osgi.service.blueprint.reflect.ValueMetadata; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.w3c.dom.Attr; 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_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"; private static final Logger LOG = LoggerFactory.getLogger(OpendaylightNamespaceHandler.class); 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 ACTION_SERVICE = "action-service"; + private static final String SPECIFIC_SERVICE_REF_LIST = "specific-reference-list"; + private static final String STATIC_REFERENCE = "static-reference"; @SuppressWarnings("rawtypes") @Override @@ -50,8 +82,8 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } @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; @@ -61,16 +93,48 @@ 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)) { + return parseClusteredAppConfig(element, context); + } else if (nodeNameEquals(element, SPECIFIC_SERVICE_REF_LIST)) { + 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) { - 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); + } else if (nodeNameEquals(node, TYPE_ATTR)) { + 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("Unsupported attribute: " + node.getNodeName()); @@ -79,29 +143,85 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } } - private static ComponentMetadata decorateRestartDependentsOnUpdates(Attr attr, ComponentMetadata component, - ParserContext context) { - if(component != null) { - throw new ComponentDefinitionException("Attribute " + attr.getNodeName() + - " can only be used on the root element"); + private static ComponentMetadata decorateServiceType(final Attr attr, final ComponentMetadata component, + final ParserContext context) { + if (!(component instanceof MutableServiceMetadata)) { + throw new ComponentDefinitionException("Expected an instanceof MutableServiceMetadata"); } - LOG.debug("decorateRestartDependentsOnUpdates: {}", attr.getValue()); + 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 static ComponentMetadata decorateServiceReferenceType(final Attr attr, final ComponentMetadata component, + final ParserContext context) { + if (!(component instanceof MutableServiceReferenceMetadata)) { + throw new ComponentDefinitionException("Expected an instanceof MutableServiceReferenceMetadata"); + } + + // We don't actually need the ComponentProcessor for augmenting the OSGi filter here but we create it + // to workaround an issue in Aries where it doesn't use the extended filter unless there's a + // Processor or ComponentDefinitionRegistryProcessor registered. This may actually be working as + // designed in Aries b/c the extended filter was really added to allow the OSGi filter to be + // substituted by a variable via the "cm:property-placeholder" processor. If so, it's a bit funky + // but as long as there's at least one processor registered, it correctly uses the extended filter. + registerComponentProcessor(context); + + MutableServiceReferenceMetadata serviceRef = (MutableServiceReferenceMetadata)component; + String oldFilter = serviceRef.getExtendedFilter() == null ? null : + serviceRef.getExtendedFilter().getStringValue(); + + String filter; + if (Strings.isNullOrEmpty(oldFilter)) { + filter = String.format("(type=%s)", attr.getValue()); + } else { + filter = String.format("(&(%s)(type=%s))", oldFilter, attr.getValue()); + } - if(!Boolean.TRUE.equals(Boolean.valueOf(attr.getValue()))) { + LOG.debug("decorateServiceReferenceType for {} with type {}, old filter: {}, new filter: {}", + serviceRef.getId(), attr.getValue(), oldFilter, filter); + + serviceRef.setExtendedFilter(createValue(context, filter)); + return component; + } + + private static ComponentMetadata decorateRestartDependentsOnUpdates(final Attr attr, + final ComponentMetadata component, final ParserContext context) { + return enableComponentProcessorProperty(attr, component, context, "restartDependentsOnUpdates"); + } + + private static ComponentMetadata decorateUseDefaultForReferenceTypes(final Attr attr, + final ComponentMetadata component, final ParserContext context) { + return enableComponentProcessorProperty(attr, component, context, "useDefaultForReferenceTypes"); + } + + 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()); + + if (!Boolean.parseBoolean(attr.getValue())) { return component; } MutableBeanMetadata metadata = registerComponentProcessor(context); - metadata.addProperty("restartDependentsOnUpdates", createValue(context, "true")); + metadata.addProperty(propertyName, createValue(context, "true")); 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) { + if (metadata == null) { metadata = context.createMetadata(MutableBeanMetadata.class); metadata.setProcessor(true); metadata.setId(COMPONENT_PROCESSOR_NAME); @@ -121,33 +241,254 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return metadata; } - private static ValueMetadata createValue(ParserContext context, String value) { - MutableValueMetadata m = context.createMetadata(MutableValueMetadata.class); - m.setStringValue(value); - return m; + 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(ActionProviderBean.class); + metadata.setInitMethod("init"); + metadata.setDestroyMethod("destroy"); + metadata.addProperty("bundle", createRef(context, "blueprintBundle")); + 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 = 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("parseRpcImplementation returning {}", metadata); + return metadata; + } + + private static Metadata parseRoutedRpcImplementation(final Element element, final 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 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 Metadata parseActionService(final Element element, final ParserContext context) { + ComponentFactoryMetadata metadata = new ActionServiceMetadata(getId(context, element), + element.getAttribute(INTERFACE)); - if(filter != null) { - m.setFilter(filter); + 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)); + + LOG.debug("parseRpcService returning {}", metadata); + + return metadata; + } + + 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); + metadata.setActivation(ReferenceMetadata.ACTIVATION_LAZY); + metadata.setRuntimeClass(RoutedRpcRegistrationConverter.class); + registry.registerTypeConverter(metadata); } + } + + private static void registerRpcProviderServiceRefBean(final ParserContext context) { + registerRefBean(context, RPC_PROVIDER_SERVICE_NAME, DOMRpcProviderService.class); + } - return m; + private static void registerRpcRegistryServiceRefBean(final ParserContext context) { + registerRefBean(context, RPC_REGISTRY_NAME, RpcProviderRegistry.class); } - private static RefMetadata createRef(ParserContext context, String value) { + private static void registerSchemaServiceRefBean(final ParserContext context) { + registerRefBean(context, SCHEMA_SERVICE_NAME, SchemaService.class); + } + + private static void registerRefBean(final ParserContext context, final String name, final Class clazz) { + ComponentDefinitionRegistry registry = context.getComponentDefinitionRegistry(); + if (registry.getComponentDefinition(name) == null) { + MutableReferenceMetadata metadata = createServiceRef(context, clazz, null); + metadata.setId(name); + registry.registerComponentDefinition(metadata); + } + } + + 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")); + 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 static void registerNotificationServiceRefBean(final 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 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++) { + Node child = children.item(i); + if (nodeNameEquals(child, DataStoreAppConfigMetadata.DEFAULT_CONFIG)) { + defaultConfigElement = (Element) child; + break; + } + } + + Element defaultAppConfigElement = 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++) { + Node child = children.item(i); + if (child.getNodeType() == Node.CDATA_SECTION_NODE) { + defaultAppConfigElement = parseXML(DataStoreAppConfigMetadata.DEFAULT_CONFIG, + child.getTextContent()); + break; + } + } + } + + return new DataStoreAppConfigMetadata(getId(context, element), element.getAttribute( + DataStoreAppConfigMetadata.BINDING_CLASS), element.getAttribute( + DataStoreAppConfigMetadata.LIST_KEY_VALUE), element.getAttribute( + DataStoreAppConfigMetadata.DEFAULT_CONFIG_FILE_NAME), parseUpdateStrategy( + element.getAttribute(UPDATE_STRATEGY_ATTR)), defaultAppConfigElement); + } + + 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 static Metadata parseSpecificReferenceList(final Element element, final ParserContext context) { + ComponentFactoryMetadata metadata = new SpecificReferenceListMetadata(getId(context, element), + element.getAttribute(INTERFACE)); + + LOG.debug("parseSpecificReferenceList returning {}", metadata); + + return metadata; + } + + private static Metadata parseStaticReference(final Element element, final ParserContext context) { + ComponentFactoryMetadata metadata = new StaticReferenceMetadata(getId(context, element), + element.getAttribute(INTERFACE)); + + LOG.debug("parseStaticReference returning {}", metadata); + + return metadata; + } + + private static Element parseXML(final String name, final String xml) { + try { + 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(final ParserContext context, final String value) { + MutableValueMetadata metadata = context.createMetadata(MutableValueMetadata.class); + metadata.setStringValue(value); + return metadata; + } + + 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) { + metadata.setFilter(filter); + } + + return metadata; + } + + private static RefMetadata createRef(final ParserContext context, final String id) { MutableRefMetadata metadata = context.createMetadata(MutableRefMetadata.class); - metadata.setComponentId(value); + metadata.setComponentId(id); return metadata; } - private static boolean nodeNameEquals(Node node, String name) { + 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(final Node node, final String name) { return name.equals(node.getNodeName()) || name.equals(node.getLocalName()); } }