X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-rest-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fstreams%2Flisteners%2FListenerAdapter.java;h=e526ec13be75fad83ff6c33b95dfe9ba0d809298;hp=6282f37602be8236a737fe3e8ef42852816756bc;hb=73c9fecf86aad02761df47fe0cc943af4ea1f2bc;hpb=8a8f76419087916c3f573eb17a321f78c127c806 diff --git a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/streams/listeners/ListenerAdapter.java b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/streams/listeners/ListenerAdapter.java index 6282f37602..e526ec13be 100644 --- a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/streams/listeners/ListenerAdapter.java +++ b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/streams/listeners/ListenerAdapter.java @@ -7,10 +7,14 @@ */ package org.opendaylight.controller.sal.streams.listeners; +import com.google.common.base.Charsets; +import com.google.common.base.Preconditions; +import com.google.common.eventbus.AsyncEventBus; +import com.google.common.eventbus.EventBus; +import com.google.common.eventbus.Subscribe; import io.netty.channel.Channel; import io.netty.handler.codec.http.websocketx.TextWebSocketFrame; import io.netty.util.internal.ConcurrentSet; - import java.io.ByteArrayOutputStream; import java.io.OutputStreamWriter; import java.io.UnsupportedEncodingException; @@ -23,7 +27,7 @@ import java.util.Map.Entry; import java.util.Random; import java.util.Set; import java.util.concurrent.Executors; - +import java.util.regex.Pattern; import javax.activation.UnsupportedDataTypeException; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; @@ -34,7 +38,6 @@ import javax.xml.transform.TransformerException; import javax.xml.transform.TransformerFactory; import javax.xml.transform.dom.DOMSource; import javax.xml.transform.stream.StreamResult; - import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent; import org.opendaylight.controller.sal.core.api.data.DataChangeListener; import org.opendaylight.controller.sal.rest.impl.XmlMapper; @@ -53,22 +56,18 @@ import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; -import com.google.common.base.Preconditions; -import com.google.common.eventbus.AsyncEventBus; -import com.google.common.eventbus.EventBus; -import com.google.common.eventbus.Subscribe; - /** - * {@link ListenerAdapter} is responsible to track events, which occurred by - * changing data in data source. + * {@link ListenerAdapter} is responsible to track events, which occurred by changing data in data source. */ public class ListenerAdapter implements DataChangeListener { - private static final Logger logger = LoggerFactory - .getLogger(ListenerAdapter.class); + private static final Logger LOG = LoggerFactory.getLogger(ListenerAdapter.class); + private static final DocumentBuilderFactory DBF = DocumentBuilderFactory.newInstance(); + private static final TransformerFactory FACTORY = TransformerFactory.newInstance(); + private static final Pattern RFC3339_PATTERN = Pattern.compile("(\\d\\d)(\\d\\d)$"); + private final XmlMapper xmlMapper = new XmlMapper(); - private final SimpleDateFormat rfc3339 = new SimpleDateFormat( - "yyyy-MM-dd'T'hh:mm:ssZ"); + private final SimpleDateFormat rfc3339 = new SimpleDateFormat("yyyy-MM-dd'T'hh:mm:ssZ"); private final InstanceIdentifier path; private ListenerRegistration registration; @@ -78,18 +77,16 @@ public class ListenerAdapter implements DataChangeListener { private final EventBusChangeRecorder eventBusChangeRecorder; /** - * Creates new {@link ListenerAdapter} listener specified by path and stream - * name. + * Creates new {@link ListenerAdapter} listener specified by path and stream name. * * @param path * Path to data in data store. * @param streamName * The name of the stream. */ - ListenerAdapter(InstanceIdentifier path, String streamName) { + ListenerAdapter(final InstanceIdentifier path, final String streamName) { Preconditions.checkNotNull(path); - Preconditions - .checkArgument(streamName != null && !streamName.isEmpty()); + Preconditions.checkArgument(streamName != null && !streamName.isEmpty()); this.path = path; this.streamName = streamName; eventBus = new AsyncEventBus(Executors.newSingleThreadExecutor()); @@ -98,14 +95,10 @@ public class ListenerAdapter implements DataChangeListener { } @Override - public void onDataChanged( - DataChangeEvent change) { - if (!change.getCreatedConfigurationData().isEmpty() - || !change.getCreatedOperationalData().isEmpty() - || !change.getUpdatedConfigurationData().isEmpty() - || !change.getUpdatedOperationalData().isEmpty() - || !change.getRemovedConfigurationData().isEmpty() - || !change.getRemovedOperationalData().isEmpty()) { + public void onDataChanged(final DataChangeEvent change) { + if (!change.getCreatedConfigurationData().isEmpty() || !change.getCreatedOperationalData().isEmpty() + || !change.getUpdatedConfigurationData().isEmpty() || !change.getUpdatedOperationalData().isEmpty() + || !change.getRemovedConfigurationData().isEmpty() || !change.getRemovedOperationalData().isEmpty()) { String xml = prepareXmlFrom(change); Event event = new Event(EventType.NOTIFY); event.setData(xml); @@ -118,7 +111,7 @@ public class ListenerAdapter implements DataChangeListener { */ private final class EventBusChangeRecorder { @Subscribe - public void recordCustomerChange(Event event) { + public void recordCustomerChange(final Event event) { if (event.getType() == EventType.REGISTER) { Channel subscriber = event.getSubscriber(); if (!subscribers.contains(subscriber)) { @@ -126,19 +119,14 @@ public class ListenerAdapter implements DataChangeListener { } } else if (event.getType() == EventType.DEREGISTER) { subscribers.remove(event.getSubscriber()); - Notificator - .removeListenerIfNoSubscriberExists(ListenerAdapter.this); + Notificator.removeListenerIfNoSubscriberExists(ListenerAdapter.this); } else if (event.getType() == EventType.NOTIFY) { for (Channel subscriber : subscribers) { if (subscriber.isActive()) { - logger.debug("Data are sent to subscriber {}:", - subscriber.remoteAddress()); - subscriber.writeAndFlush(new TextWebSocketFrame(event - .getData())); + LOG.debug("Data are sent to subscriber {}:", subscriber.remoteAddress()); + subscriber.writeAndFlush(new TextWebSocketFrame(event.getData())); } else { - logger.debug( - "Subscriber {} is removed - channel is not active yet.", - subscriber.remoteAddress()); + LOG.debug("Subscriber {} is removed - channel is not active yet.", subscriber.remoteAddress()); subscribers.remove(subscriber); } } @@ -147,8 +135,7 @@ public class ListenerAdapter implements DataChangeListener { } /** - * Represents event of specific {@link EventType} type, holds data and - * {@link Channel} subscriber. + * Represents event of specific {@link EventType} type, holds data and {@link Channel} subscriber. */ private final class Event { private final EventType type; @@ -161,7 +148,7 @@ public class ListenerAdapter implements DataChangeListener { * @param type * EventType */ - public Event(EventType type) { + public Event(final EventType type) { this.type = type; } @@ -180,7 +167,7 @@ public class ListenerAdapter implements DataChangeListener { * @param subscriber * Channel */ - public void setSubscriber(Channel subscriber) { + public void setSubscriber(final Channel subscriber) { this.subscriber = subscriber; } @@ -199,7 +186,7 @@ public class ListenerAdapter implements DataChangeListener { * @param String * data. */ - public void setData(String data) { + public void setData(final String data) { this.data = data; } @@ -217,7 +204,9 @@ public class ListenerAdapter implements DataChangeListener { * Type of the event. */ private enum EventType { - REGISTER, DEREGISTER, NOTIFY; + REGISTER, + DEREGISTER, + NOTIFY; } /** @@ -227,11 +216,9 @@ public class ListenerAdapter implements DataChangeListener { * DataChangeEvent * @return Data in printable form. */ - private String prepareXmlFrom( - DataChangeEvent change) { + private String prepareXmlFrom(final DataChangeEvent change) { Document doc = createDocument(); - Element notificationElement = doc.createElementNS( - "urn:ietf:params:xml:ns:netconf:notification:1.0", + Element notificationElement = doc.createElementNS("urn:ietf:params:xml:ns:netconf:notification:1.0", "notification"); doc.appendChild(notificationElement); @@ -240,30 +227,24 @@ public class ListenerAdapter implements DataChangeListener { notificationElement.appendChild(eventTimeElement); Element dataChangedNotificationEventElement = doc.createElementNS( - "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", - "data-changed-notification"); - addValuesToDataChangedNotificationEventElement(doc, - dataChangedNotificationEventElement, change); + "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "data-changed-notification"); + addValuesToDataChangedNotificationEventElement(doc, dataChangedNotificationEventElement, change); notificationElement.appendChild(dataChangedNotificationEventElement); try { ByteArrayOutputStream out = new ByteArrayOutputStream(); - TransformerFactory tf = TransformerFactory.newInstance(); - Transformer transformer = tf.newTransformer(); - transformer - .setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no"); + Transformer transformer = FACTORY.newTransformer(); + transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no"); transformer.setOutputProperty(OutputKeys.METHOD, "xml"); transformer.setOutputProperty(OutputKeys.INDENT, "yes"); transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8"); - transformer.setOutputProperty( - "{http://xml.apache.org/xslt}indent-amount", "4"); - transformer.transform(new DOMSource(doc), new StreamResult( - new OutputStreamWriter(out, "UTF-8"))); + transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4"); + transformer.transform(new DOMSource(doc), new StreamResult(new OutputStreamWriter(out, Charsets.UTF_8))); byte[] charData = out.toByteArray(); return new String(charData, "UTF-8"); } catch (TransformerException | UnsupportedEncodingException e) { String msg = "Error during transformation of Document into String"; - logger.error(msg, e); + LOG.error(msg, e); return msg; } } @@ -275,8 +256,8 @@ public class ListenerAdapter implements DataChangeListener { * Date * @return Data specified by RFC3339. */ - private String toRFC3339(Date d) { - return rfc3339.format(d).replaceAll("(\\d\\d)(\\d\\d)$", "$1:$2"); + private String toRFC3339(final Date d) { + return RFC3339_PATTERN.matcher(rfc3339.format(d)).replaceAll("$1:$2"); } /** @@ -285,15 +266,13 @@ public class ListenerAdapter implements DataChangeListener { * @return {@link Document} document. */ private Document createDocument() { - DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); - Document doc = null; + final DocumentBuilder bob; try { - DocumentBuilder bob = dbf.newDocumentBuilder(); - doc = bob.newDocument(); + bob = DBF.newDocumentBuilder(); } catch (ParserConfigurationException e) { return null; } - return doc; + return bob.newDocument(); } /** @@ -306,32 +285,25 @@ public class ListenerAdapter implements DataChangeListener { * @param change * {@link DataChangeEvent} */ - private void addValuesToDataChangedNotificationEventElement(Document doc, - Element dataChangedNotificationEventElement, - DataChangeEvent change) { - addValuesFromDataToElement(doc, change.getCreatedConfigurationData(), - dataChangedNotificationEventElement, Store.CONFIG, - Operation.CREATED); - addValuesFromDataToElement(doc, change.getCreatedOperationalData(), - dataChangedNotificationEventElement, Store.OPERATION, - Operation.CREATED); + private void addValuesToDataChangedNotificationEventElement(final Document doc, + final Element dataChangedNotificationEventElement, + final DataChangeEvent change) { + addValuesFromDataToElement(doc, change.getCreatedConfigurationData(), dataChangedNotificationEventElement, + Store.CONFIG, Operation.CREATED); + addValuesFromDataToElement(doc, change.getCreatedOperationalData(), dataChangedNotificationEventElement, + Store.OPERATION, Operation.CREATED); if (change.getCreatedConfigurationData().isEmpty()) { - addValuesFromDataToElement(doc, - change.getUpdatedConfigurationData(), - dataChangedNotificationEventElement, Store.CONFIG, - Operation.UPDATED); + addValuesFromDataToElement(doc, change.getUpdatedConfigurationData(), dataChangedNotificationEventElement, + Store.CONFIG, Operation.UPDATED); } if (change.getCreatedOperationalData().isEmpty()) { - addValuesFromDataToElement(doc, change.getUpdatedOperationalData(), - dataChangedNotificationEventElement, Store.OPERATION, - Operation.UPDATED); + addValuesFromDataToElement(doc, change.getUpdatedOperationalData(), dataChangedNotificationEventElement, + Store.OPERATION, Operation.UPDATED); } - addValuesFromDataToElement(doc, change.getRemovedConfigurationData(), - dataChangedNotificationEventElement, Store.CONFIG, - Operation.DELETED); - addValuesFromDataToElement(doc, change.getRemovedOperationalData(), - dataChangedNotificationEventElement, Store.OPERATION, - Operation.DELETED); + addValuesFromDataToElement(doc, change.getRemovedConfigurationData(), dataChangedNotificationEventElement, + Store.CONFIG, Operation.DELETED); + addValuesFromDataToElement(doc, change.getRemovedOperationalData(), dataChangedNotificationEventElement, + Store.OPERATION, Operation.DELETED); } /** @@ -348,15 +320,13 @@ public class ListenerAdapter implements DataChangeListener { * @param operation * {@link Operation} */ - private void addValuesFromDataToElement(Document doc, - Set data, Element element, Store store, - Operation operation) { + private void addValuesFromDataToElement(final Document doc, final Set data, + final Element element, final Store store, final Operation operation) { if (data == null || data.isEmpty()) { return; } for (InstanceIdentifier path : data) { - Node node = createDataChangeEventElement(doc, path, null, store, - operation); + Node node = createDataChangeEventElement(doc, path, null, store, operation); element.appendChild(node); } } @@ -375,15 +345,13 @@ public class ListenerAdapter implements DataChangeListener { * @param operation * {@link Operation} */ - private void addValuesFromDataToElement(Document doc, - Map data, Element element, - Store store, Operation operation) { + private void addValuesFromDataToElement(final Document doc, final Map data, + final Element element, final Store store, final Operation operation) { if (data == null || data.isEmpty()) { return; } for (Entry entry : data.entrySet()) { - Node node = createDataChangeEventElement(doc, entry.getKey(), - entry.getValue(), store, operation); + Node node = createDataChangeEventElement(doc, entry.getKey(), entry.getValue(), store, operation); element.appendChild(node); } } @@ -403,9 +371,8 @@ public class ListenerAdapter implements DataChangeListener { * {@link Operation} * @return {@link Node} node represented by changed event element. */ - private Node createDataChangeEventElement(Document doc, - InstanceIdentifier path, CompositeNode data, Store store, - Operation operation) { + private Node createDataChangeEventElement(final Document doc, final InstanceIdentifier path, + final CompositeNode data, final Store store, final Operation operation) { Element dataChangeEventElement = doc.createElement("data-change-event"); Element pathElement = doc.createElement("path"); @@ -440,11 +407,10 @@ public class ListenerAdapter implements DataChangeListener { * {@link CompositeNode} * @return Data in XML format. */ - private Node translateToXml(InstanceIdentifier path, CompositeNode data) { - DataNodeContainer schemaNode = ControllerContext.getInstance() - .getDataNodeContainerFor(path); + private Node translateToXml(final InstanceIdentifier path, final CompositeNode data) { + DataNodeContainer schemaNode = ControllerContext.getInstance().getDataNodeContainerFor(path); if (schemaNode == null) { - logger.info( + LOG.info( "Path '{}' contains node with unsupported type (supported type is Container or List) or some node was not found.", path); return null; @@ -453,9 +419,7 @@ public class ListenerAdapter implements DataChangeListener { Document xml = xmlMapper.write(data, schemaNode); return xml.getFirstChild(); } catch (UnsupportedDataTypeException e) { - logger.error( - "Error occured during translation of notification to XML.", - e); + LOG.error("Error occured during translation of notification to XML.", e); return null; } } @@ -468,25 +432,22 @@ public class ListenerAdapter implements DataChangeListener { * @param element * {@link Element} */ - private void addPathAsValueToElement(InstanceIdentifier path, - Element element) { + private void addPathAsValueToElement(final InstanceIdentifier path, final Element element) { // Map< key = namespace, value = prefix> Map prefixes = new HashMap<>(); InstanceIdentifier instanceIdentifier = path; StringBuilder textContent = new StringBuilder(); - for (PathArgument pathArgument : instanceIdentifier.getPath()) { + + // FIXME: BUG-1281: this is duplicated code from yangtools (BUG-1275) + for (PathArgument pathArgument : instanceIdentifier.getPathArguments()) { textContent.append("/"); - writeIdentifierWithNamespacePrefix(element, textContent, - pathArgument.getNodeType(), prefixes); + writeIdentifierWithNamespacePrefix(element, textContent, pathArgument.getNodeType(), prefixes); if (pathArgument instanceof NodeIdentifierWithPredicates) { - Map predicates = ((NodeIdentifierWithPredicates) pathArgument) - .getKeyValues(); + Map predicates = ((NodeIdentifierWithPredicates) pathArgument).getKeyValues(); for (QName keyValue : predicates.keySet()) { - String predicateValue = String.valueOf(predicates - .get(keyValue)); + String predicateValue = String.valueOf(predicates.get(keyValue)); textContent.append("["); - writeIdentifierWithNamespacePrefix(element, textContent, - keyValue, prefixes); + writeIdentifierWithNamespacePrefix(element, textContent, keyValue, prefixes); textContent.append("='"); textContent.append(predicateValue); textContent.append("'"); @@ -514,14 +475,13 @@ public class ListenerAdapter implements DataChangeListener { * @param prefixes * Map of namespaces and prefixes. */ - private static void writeIdentifierWithNamespacePrefix(Element element, - StringBuilder textContent, QName qName, Map prefixes) { + private static void writeIdentifierWithNamespacePrefix(final Element element, final StringBuilder textContent, + final QName qName, final Map prefixes) { String namespace = qName.getNamespace().toString(); String prefix = prefixes.get(namespace); if (prefix == null) { prefix = qName.getPrefix(); - if (prefix == null || prefix.isEmpty() - || prefixes.containsValue(prefix)) { + if (prefix == null || prefix.isEmpty() || prefixes.containsValue(prefix)) { prefix = generateNewPrefix(prefixes.values()); } } @@ -541,7 +501,7 @@ public class ListenerAdapter implements DataChangeListener { * Collection of prefixes. * @return New prefix which consists of four random characters . */ - private static String generateNewPrefix(Collection prefixes) { + private static String generateNewPrefix(final Collection prefixes) { StringBuilder result = null; Random random = new Random(); do { @@ -570,8 +530,7 @@ public class ListenerAdapter implements DataChangeListener { * @param registration * ListenerRegistration */ - public void setRegistration( - ListenerRegistration registration) { + public void setRegistration(final ListenerRegistration registration) { this.registration = registration; } @@ -585,8 +544,7 @@ public class ListenerAdapter implements DataChangeListener { } /** - * Removes all subscribers and unregisters event bus change recorder form - * event bus. + * Removes all subscribers and unregisters event bus change recorder form event bus. */ public void close() throws Exception { subscribers = new ConcurrentSet<>(); @@ -605,16 +563,15 @@ public class ListenerAdapter implements DataChangeListener { } /** - * Creates event of type {@link EventType#REGISTER}, set {@link Channel} - * subscriber to the event and post event into event bus. + * Creates event of type {@link EventType#REGISTER}, set {@link Channel} subscriber to the event and post event into + * event bus. * * @param subscriber * Channel */ - public void addSubscriber(Channel subscriber) { + public void addSubscriber(final Channel subscriber) { if (!subscriber.isActive()) { - logger.debug("Channel is not active between websocket server and subscriber {}" - + subscriber.remoteAddress()); + LOG.debug("Channel is not active between websocket server and subscriber {}" + subscriber.remoteAddress()); } Event event = new Event(EventType.REGISTER); event.setSubscriber(subscriber); @@ -622,13 +579,13 @@ public class ListenerAdapter implements DataChangeListener { } /** - * Creates event of type {@link EventType#DEREGISTER}, sets {@link Channel} - * subscriber to the event and posts event into event bus. + * Creates event of type {@link EventType#DEREGISTER}, sets {@link Channel} subscriber to the event and posts event + * into event bus. * * @param subscriber */ - public void removeSubscriber(Channel subscriber) { - logger.debug("Subscriber {} is removed.", subscriber.remoteAddress()); + public void removeSubscriber(final Channel subscriber) { + LOG.debug("Subscriber {} is removed.", subscriber.remoteAddress()); Event event = new Event(EventType.DEREGISTER); event.setSubscriber(subscriber); eventBus.post(event); @@ -637,8 +594,7 @@ public class ListenerAdapter implements DataChangeListener { /** * Checks if exists at least one {@link Channel} subscriber. * - * @return True if exist at least one {@link Channel} subscriber, false - * otherwise. + * @return True if exist at least one {@link Channel} subscriber, false otherwise. */ public boolean hasSubscribers() { return !subscribers.isEmpty(); @@ -648,25 +604,27 @@ public class ListenerAdapter implements DataChangeListener { * Consists of two types {@link Store#CONFIG} and {@link Store#OPERATION}. */ private static enum Store { - CONFIG("config"), OPERATION("operation"); + CONFIG("config"), + OPERATION("operation"); private final String value; - private Store(String value) { + private Store(final String value) { this.value = value; } } /** - * Consists of three types {@link Operation#CREATED}, - * {@link Operation#UPDATED} and {@link Operation#DELETED}. + * Consists of three types {@link Operation#CREATED}, {@link Operation#UPDATED} and {@link Operation#DELETED}. */ private static enum Operation { - CREATED("created"), UPDATED("updated"), DELETED("deleted"); + CREATED("created"), + UPDATED("updated"), + DELETED("deleted"); private final String value; - private Operation(String value) { + private Operation(final String value) { this.value = value; } }