From 33767a11f3aec774ec2ac8c13cc18b0ff0da9c10 Mon Sep 17 00:00:00 2001 From: Tom Pantelis Date: Mon, 21 Mar 2016 07:27:36 -0400 Subject: [PATCH] Add blueprint extension to register notification listener Added a blueprint extension element that registers a NotificationListener implementation with the MD-SAL NotificationService. Change-Id: I5ba9b1124ccba4d5c0f8d2e323eb3dd0e918cd94 Signed-off-by: Tom Pantelis --- .../ext/NotificationListenerBean.java | 55 +++++++++++++++++++ .../ext/OpendaylightNamespaceHandler.java | 32 +++++++++++ .../opendaylight-blueprint-ext-1.0.0.xsd | 5 ++ 3 files changed, 92 insertions(+) create mode 100644 opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/NotificationListenerBean.java diff --git a/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/NotificationListenerBean.java b/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/NotificationListenerBean.java new file mode 100644 index 0000000000..bdef13f59c --- /dev/null +++ b/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/NotificationListenerBean.java @@ -0,0 +1,55 @@ +/* + * Copyright (c) 2016 Brocade Communications Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ +package org.opendaylight.controller.blueprint.ext; + +import org.opendaylight.controller.md.sal.binding.api.NotificationService; +import org.opendaylight.yangtools.concepts.ListenerRegistration; +import org.opendaylight.yangtools.yang.binding.NotificationListener; +import org.osgi.framework.Bundle; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Blueprint bean corresponding to the "notification-listener" element that registers a NotificationListener + * with the NotificationService. + * + * @author Thomas Pantelis + */ +public class NotificationListenerBean { + private static final Logger LOG = LoggerFactory.getLogger(NotificationListenerBean.class); + static final String NOTIFICATION_LISTENER = "notification-listener"; + + private Bundle bundle; + private NotificationService notificationService; + private NotificationListener notificationListener; + private ListenerRegistration registration; + + public void setNotificationService(NotificationService notificationService) { + this.notificationService = notificationService; + } + public void setNotificationListener(NotificationListener notificationListener) { + this.notificationListener = notificationListener; + } + + public void setBundle(Bundle bundle) { + this.bundle = bundle; + } + + @SuppressWarnings({ }) + public void init() { + LOG.debug("{}: init - registering NotificationListener {}", bundle.getSymbolicName(), notificationListener); + + registration = notificationService.registerNotificationListener(notificationListener); + } + + public void destroy() { + if(registration != null) { + registration.close(); + } + } +} 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 bafc1f7a73..297c3d4484 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 @@ -22,6 +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.osgi.service.blueprint.container.ComponentDefinitionException; import org.osgi.service.blueprint.reflect.BeanMetadata; @@ -47,6 +48,7 @@ public 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"; private static final Logger LOG = LoggerFactory.getLogger(OpendaylightNamespaceHandler.class); private static final String COMPONENT_PROCESSOR_NAME = ComponentProcessor.class.getName(); @@ -85,6 +87,8 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { 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); } throw new ComponentDefinitionException("Unsupported standalone element: " + element.getNodeName()); @@ -277,6 +281,34 @@ public class OpendaylightNamespaceHandler implements NamespaceHandler { } } + 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 static ValueMetadata createValue(ParserContext context, String value) { MutableValueMetadata m = context.createMetadata(MutableValueMetadata.class); m.setStringValue(value); diff --git a/opendaylight/blueprint/src/main/resources/opendaylight-blueprint-ext-1.0.0.xsd b/opendaylight/blueprint/src/main/resources/opendaylight-blueprint-ext-1.0.0.xsd index 3632ccb3a4..0c6eaaa2f0 100644 --- a/opendaylight/blueprint/src/main/resources/opendaylight-blueprint-ext-1.0.0.xsd +++ b/opendaylight/blueprint/src/main/resources/opendaylight-blueprint-ext-1.0.0.xsd @@ -28,4 +28,9 @@ + + + + + \ No newline at end of file -- 2.36.6