opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/eventsources/netconf/ConnectionNotificationTopicRegistration.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.messagebus.eventsources.netconf;
   9
  10 import java.net.URI;
  11 import java.util.ArrayList;
  12 import java.util.concurrent.ConcurrentHashMap;
  13
  14 import javax.xml.parsers.DocumentBuilder;
  15 import javax.xml.parsers.DocumentBuilderFactory;
  16 import javax.xml.parsers.ParserConfigurationException;
  17 import javax.xml.transform.dom.DOMSource;
  18
  19 import org.opendaylight.controller.md.sal.dom.api.DOMNotification;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationListener;
  21 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.TopicId;
  22 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.EventSourceStatus;
  23 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.EventSourceStatusNotification;
  24 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.EventSourceStatusNotificationBuilder;
  25 import org.opendaylight.yangtools.yang.common.QName;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  27 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  29 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  30 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33 import org.w3c.dom.Document;
  34 import org.w3c.dom.Element;
  35
  36 import com.google.common.base.Optional;
  37 import com.google.common.base.Preconditions;
  38
  39 public class ConnectionNotificationTopicRegistration extends NotificationTopicRegistration {
  40
  41     private static final Logger LOG = LoggerFactory.getLogger(ConnectionNotificationTopicRegistration.class);
  42
  43     public static final SchemaPath EVENT_SOURCE_STATUS_PATH = SchemaPath.create(true, QName.create(EventSourceStatusNotification.QNAME, "event-source-status"));
  44     private static final NodeIdentifier EVENT_SOURCE_STATUS_ARG = new NodeIdentifier(EventSourceStatusNotification.QNAME);
  45     private static final String XMLNS_ATTRIBUTE_KEY = "xmlns";
  46     private static final String XMLNS_URI = "http://www.w3.org/2000/xmlns/";
  47
  48     private final DOMNotificationListener domNotificationListener;
  49     private ConcurrentHashMap<SchemaPath, ArrayList<TopicId>> notificationTopicMap = new ConcurrentHashMap<>();
  50
  51     public ConnectionNotificationTopicRegistration(String SourceName, DOMNotificationListener domNotificationListener) {
  52         super(NotificationSourceType.ConnectionStatusChange, SourceName, EVENT_SOURCE_STATUS_PATH.getLastComponent().getNamespace().toString());
  53         this.domNotificationListener = Preconditions.checkNotNull(domNotificationListener);
  54         LOG.info("Connection notification source has been initialized...");
  55         setActive(true);
  56         setReplaySupported(false);
  57     }
  58
  59     @Override
  60     public void close() throws Exception {
  61         LOG.info("Connection notification - publish Deactive");
  62         publishNotification(EventSourceStatus.Deactive);
  63         notificationTopicMap.clear();
  64         setActive(false);
  65     }
  66
  67     @Override
  68     void activateNotificationSource() {
  69         LOG.info("Connection notification - publish Active");
  70         publishNotification(EventSourceStatus.Active);
  71     }
  72
  73     @Override
  74     void deActivateNotificationSource() {
  75         LOG.info("Connection notification - publish Inactive");
  76         publishNotification(EventSourceStatus.Inactive);
  77     }
  78
  79     @Override
  80     void reActivateNotificationSource() {
  81         LOG.info("Connection notification - reactivate - publish active");
  82         publishNotification(EventSourceStatus.Active);
  83     }
  84
  85     @Override
  86     boolean registerNotificationTopic(SchemaPath notificationPath, TopicId topicId) {
  87         if(validateNotifactionSchemaPath(notificationPath) == false){
  88             LOG.debug("Bad SchemaPath for notification try to register");
  89             return false;
  90         }
  91         ArrayList<TopicId> topicIds = getNotificationTopicIds(notificationPath);
  92         if(topicIds == null){
  93             topicIds = new ArrayList<>();
  94             topicIds.add(topicId);
  95         } else {
  96             if(topicIds.contains(topicId) == false){
  97                 topicIds.add(topicId);
  98             }
  99         }
 100         notificationTopicMap.put(notificationPath, topicIds);
 101         return true;
 102     }
 103
 104     @Override
 105     ArrayList<TopicId> getNotificationTopicIds(SchemaPath notificationPath) {
 106         return notificationTopicMap.get(notificationPath);
 107     }
 108
 109     @Override
 110     void unRegisterNotificationTopic(TopicId topicId) {
 111         // TODO: need code when EventAggregator.destroyTopic will be implemented
 112     }
 113
 114     private boolean validateNotifactionSchemaPath(SchemaPath notificationPath){
 115         if(notificationPath == null){
 116             return false;
 117         }
 118         URI notificationNameSpace = notificationPath.getLastComponent().getNamespace();
 119         return getNotificationUrnPrefix().startsWith(notificationNameSpace.toString());
 120     }
 121
 122     private void publishNotification(EventSourceStatus eventSourceStatus){
 123
 124         final EventSourceStatusNotification notification = new EventSourceStatusNotificationBuilder()
 125                     .setStatus(eventSourceStatus)
 126                     .build();
 127         domNotificationListener.onNotification(createNotification(notification));
 128     }
 129
 130     private DOMNotification createNotification(EventSourceStatusNotification notification){
 131         final ContainerNode cn = Builders.containerBuilder()
 132                 .withNodeIdentifier(EVENT_SOURCE_STATUS_ARG)
 133                 .withChild(encapsulate(notification))
 134                 .build();
 135         DOMNotification dn = new DOMNotification() {
 136
 137             @Override
 138             public SchemaPath getType() {
 139                 return EVENT_SOURCE_STATUS_PATH;
 140             }
 141
 142             @Override
 143             public ContainerNode getBody() {
 144                 return cn;
 145             }
 146         };
 147         return dn;
 148     }
 149
 150     private AnyXmlNode encapsulate(EventSourceStatusNotification notification){
 151
 152         DocumentBuilderFactory docFactory = DocumentBuilderFactory.newInstance();
 153         DocumentBuilder docBuilder;
 154
 155         try {
 156             docBuilder = docFactory.newDocumentBuilder();
 157         } catch (ParserConfigurationException e) {
 158             throw new IllegalStateException("Can not create XML DocumentBuilder");
 159         }
 160
 161         Document doc = docBuilder.newDocument();
 162
 163         final Optional<String> namespace = Optional.of(EVENT_SOURCE_STATUS_ARG.getNodeType().getNamespace().toString());
 164         final Element rootElement = createElement(doc , "EventSourceStatusNotification", namespace);
 165
 166         final Element sourceElement = doc.createElement("status");
 167         sourceElement.appendChild(doc.createTextNode(notification.getStatus().name()));
 168         rootElement.appendChild(sourceElement);
 169
 170
 171         return Builders.anyXmlBuilder().withNodeIdentifier(EVENT_SOURCE_STATUS_ARG)
 172                      .withValue(new DOMSource(rootElement))
 173                      .build();
 174
 175     }
 176
 177     // Helper to create root XML element with correct namespace and attribute
 178     private Element createElement(final Document document, final String qName, final Optional<String> namespaceURI) {
 179         if(namespaceURI.isPresent()) {
 180             final Element element = document.createElementNS(namespaceURI.get(), qName);
 181             String name = XMLNS_ATTRIBUTE_KEY;
 182             if(element.getPrefix() != null) {
 183                 name += ":" + element.getPrefix();
 184             }
 185             element.setAttributeNS(XMLNS_URI, name, namespaceURI.get());
 186             return element;
 187         }
 188         return document.createElement(qName);
 189     }
 190 }