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%2FNotificator.java;h=9c8351aa99fdecc737508a7b0487c95f39582495;hp=d1cb25861ae0496c299cc9f4c67ebf5314a871e4;hb=9070e358923aca6229137d46f9cae7ff458204dd;hpb=2c7c9ef5e517de98e0d740f938762cc746dbcde1

diff --git a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/streams/listeners/Notificator.java b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/streams/listeners/Notificator.java
index d1cb25861a..9c8351aa99 100644
--- a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/streams/listeners/Notificator.java
+++ b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/streams/listeners/Notificator.java
@@ -1,100 +1,179 @@
 package org.opendaylight.controller.sal.streams.listeners;
 
 import java.util.Map;
+import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.locks.Lock;
 import java.util.concurrent.locks.ReentrantLock;
 
 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
 
+/**
+ * {@link Notificator} is responsible to create, remove and find {@link ListenerAdapter} listener.
+ */
 public class Notificator {
 
     private static Map<String, ListenerAdapter> listenersByStreamName = new ConcurrentHashMap<>();
-    private static Map<InstanceIdentifier, ListenerAdapter> listenersByInstanceIdentifier = new ConcurrentHashMap<>();
-    private static final Lock lock = new ReentrantLock();
+	private static Map<InstanceIdentifier, ListenerAdapter> listenersByInstanceIdentifier = new ConcurrentHashMap<>();
+	private static final Lock lock = new ReentrantLock();
 
-    private Notificator() {
-    }
+	private Notificator() {
+	}
 
-    public static ListenerAdapter getListenerFor(String streamName) {
-        return listenersByStreamName.get(streamName);
+    /**
+     * Returns list of all stream names
+     */
+    public static Set<String> getStreamNames() {
+        return listenersByStreamName.keySet();
     }
 
-    public static ListenerAdapter getListenerFor(InstanceIdentifier path) {
-        return listenersByInstanceIdentifier.get(path);
-    }
 
-    public static boolean existListenerFor(InstanceIdentifier path) {
-        return listenersByInstanceIdentifier.containsKey(path);
-    }
+	/**
+	 * Gets {@link ListenerAdapter} specified by stream name.
+	 * 
+	 * @param streamName
+	 *            The name of the stream.
+	 * @return {@link ListenerAdapter} specified by stream name.
+	 */
+	public static ListenerAdapter getListenerFor(String streamName) {
+		return listenersByStreamName.get(streamName);
+	}
 
-    public static ListenerAdapter createListener(InstanceIdentifier path, String streamName) {
-        ListenerAdapter listener = new ListenerAdapter(path, streamName);
-        try {
-            lock.lock();
-            listenersByInstanceIdentifier.put(path, listener);
-            listenersByStreamName.put(streamName, listener);
-        } finally {
-            lock.unlock();
-        }
-        return listener;
-    }
+	/**
+	 * Gets {@link ListenerAdapter} listener specified by
+	 * {@link InstanceIdentifier} path.
+	 * 
+	 * @param path
+	 *            Path to data in data repository.
+	 * @return ListenerAdapter
+	 */
+	public static ListenerAdapter getListenerFor(InstanceIdentifier path) {
+		return listenersByInstanceIdentifier.get(path);
+	}
 
-    public static void removeListener(InstanceIdentifier path) {
-        ListenerAdapter listener = listenersByInstanceIdentifier.get(path);
-        deleteListener(listener);
-    }
+	/**
+	 * Checks if the listener specified by {@link InstanceIdentifier} path
+	 * exist.
+	 * 
+	 * @param path
+	 *            Path to data in data repository.
+	 * @return True if the listener exist, false otherwise.
+	 */
+	public static boolean existListenerFor(InstanceIdentifier path) {
+		return listenersByInstanceIdentifier.containsKey(path);
+	}
 
-    public static String createStreamNameFromUri(String uri) {
-        if (uri == null) {
-            return null;
-        }
-        String result = uri;
-        if (result.startsWith("/")) {
-            result = result.substring(1);
-        }
-        if (result.endsWith("/")) {
-            result = result.substring(0, result.length());
-        }
-        return result;
-    }
+	/**
+	 * Creates new {@link ListenerAdapter} listener from
+	 * {@link InstanceIdentifier} path and stream name.
+	 * 
+	 * @param path
+	 *            Path to data in data repository.
+	 * @param streamName
+	 *            The name of the stream.
+	 * @return New {@link ListenerAdapter} listener from
+	 *         {@link InstanceIdentifier} path and stream name.
+	 */
+	public static ListenerAdapter createListener(InstanceIdentifier path,
+			String streamName) {
+		ListenerAdapter listener = new ListenerAdapter(path, streamName);
+		try {
+			lock.lock();
+			listenersByInstanceIdentifier.put(path, listener);
+			listenersByStreamName.put(streamName, listener);
+		} finally {
+			lock.unlock();
+		}
+		return listener;
+	}
 
-    public static void removeAllListeners() {
-        for (ListenerAdapter listener : listenersByInstanceIdentifier.values()) {
-            try {
-                listener.close();
-            } catch (Exception e) {
-            }
-        }
-        try {
-            lock.lock();
-            listenersByStreamName = new ConcurrentHashMap<>();
-            listenersByInstanceIdentifier = new ConcurrentHashMap<>();
-        } finally {
-            lock.unlock();
-        }
-    }
+	/**
+	 * Looks for listener determined by {@link InstanceIdentifier} path and
+	 * removes it.
+	 * 
+	 * @param path
+	 *            InstanceIdentifier
+	 */
+	public static void removeListener(InstanceIdentifier path) {
+		ListenerAdapter listener = listenersByInstanceIdentifier.get(path);
+		deleteListener(listener);
+	}
 
-    public static void removeListenerIfNoSubscriberExists(ListenerAdapter listener) {
-        if (!listener.hasSubscribers()) {
-            deleteListener(listener);
-        }
-    }
+	/**
+	 * Creates String representation of stream name from URI. Removes slash from
+	 * URI in start and end position.
+	 * 
+	 * @param uri
+	 *            URI for creation stream name.
+	 * @return String representation of stream name.
+	 */
+	public static String createStreamNameFromUri(String uri) {
+		if (uri == null) {
+			return null;
+		}
+		String result = uri;
+		if (result.startsWith("/")) {
+			result = result.substring(1);
+		}
+		if (result.endsWith("/")) {
+			result = result.substring(0, result.length());
+		}
+		return result;
+	}
 
-    private static void deleteListener(ListenerAdapter listener) {
-        if (listener != null) {
-            try {
-                listener.close();
-            } catch (Exception e) {
-            }
-            try {
-                lock.lock();
-                listenersByInstanceIdentifier.remove(listener.getPath());
-                listenersByStreamName.remove(listener.getStreamName());
-            } finally {
-                lock.unlock();
-            }
-        }
-    }
+	/**
+	 * Removes all listeners.
+	 */
+	public static void removeAllListeners() {
+		for (ListenerAdapter listener : listenersByInstanceIdentifier.values()) {
+			try {
+				listener.close();
+			} catch (Exception e) {
+			}
+		}
+		try {
+			lock.lock();
+			listenersByStreamName = new ConcurrentHashMap<>();
+			listenersByInstanceIdentifier = new ConcurrentHashMap<>();
+		} finally {
+			lock.unlock();
+		}
+	}
+
+	/**
+	 * Checks if listener has at least one subscriber. In case it doesn't have any, delete
+	 * listener.
+	 * 
+	 * @param listener
+	 *            ListenerAdapter
+	 */
+	public static void removeListenerIfNoSubscriberExists(
+			ListenerAdapter listener) {
+		if (!listener.hasSubscribers()) {
+			deleteListener(listener);
+		}
+	}
+
+	/**
+	 * Delete {@link ListenerAdapter} listener specified in parameter.
+	 * 
+	 * @param listener
+	 *            ListenerAdapter
+	 */
+	private static void deleteListener(ListenerAdapter listener) {
+		if (listener != null) {
+			try {
+				listener.close();
+			} catch (Exception e) {
+			}
+			try {
+				lock.lock();
+				listenersByInstanceIdentifier.remove(listener.getPath());
+				listenersByStreamName.remove(listener.getStreamName());
+			} finally {
+				lock.unlock();
+			}
+		}
+	}
 
 }
\ No newline at end of file