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=20f29ca7d04bd34baa1be9b0eaa62a606b9cddbe;hb=d8be13e36b4a5fca3155e7ab3e840ba9ab5a75b1;hp=e6ddd48234a7b5906e5eb108b846aec4c7860655;hpb=5aabe0e6b237565f07d5a81ea3dc0dee49363a20;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 e6ddd48234..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 @@ -8,11 +8,11 @@ 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; @@ -25,7 +25,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.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; @@ -42,18 +45,22 @@ 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(); @@ -64,6 +71,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"; @@ -74,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; @@ -85,7 +93,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)) { @@ -102,27 +110,31 @@ 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) { - 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()); @@ -131,7 +143,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"); } @@ -144,7 +157,8 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { 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"); } @@ -162,7 +176,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()); @@ -175,26 +189,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()); - if(!Boolean.parseBoolean(attr.getValue())) { + if (!Boolean.parseBoolean(attr.getValue())) { return component; } @@ -204,10 +218,10 @@ 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) { + if (metadata == null) { metadata = context.createMetadata(MutableBeanMetadata.class); metadata.setProcessor(true); metadata.setId(COMPONENT_PROCESSOR_NAME); @@ -227,7 +241,33 @@ 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(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); @@ -241,16 +281,15 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { metadata.addProperty("rpcRegistry", createRef(context, RPC_REGISTRY_NAME)); metadata.addProperty("implementation", createRef(context, element.getAttribute(REF_ATTR))); - if(element.hasAttribute(INTERFACE)) { + if (element.hasAttribute(INTERFACE)) { 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); @@ -262,7 +301,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)); @@ -271,9 +319,9 @@ 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) { + 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); @@ -283,16 +331,28 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } } - 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, SchemaService.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); @@ -311,37 +371,38 @@ 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) { + 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; } } @@ -350,10 +411,23 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { return new DataStoreAppConfigMetadata(getId(context, element), element.getAttribute( DataStoreAppConfigMetadata.BINDING_CLASS), element.getAttribute( DataStoreAppConfigMetadata.LIST_KEY_VALUE), element.getAttribute( - DataStoreAppConfigMetadata.DEFAULT_CONFIG_FILE_NAME), defaultAppConfigElement); + 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 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)); @@ -362,7 +436,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)); @@ -371,55 +445,50 @@ 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(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()); } }