Make all member collections final.
[jSite2.git] / src / net / pterodactylus / jsite / core / NodeManager.java
index 437dace..9cdc60d 100644 (file)
@@ -49,7 +49,7 @@ import net.pterodactylus.util.number.Hex;
 
 /**
  * TODO
- * 
+ *
  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
  */
 public class NodeManager implements Iterable<Node>, PropertyChangeListener, HighLevelClientListener {
@@ -66,24 +66,27 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
        /** Object used for synchronization. */
        private final Object syncObject = new Object();
 
-       /** Node listeners. */
-       private List<NodeListener> nodeListeners = Collections.synchronizedList(new ArrayList<NodeListener>());
+       /** Node listener support. */
+       private final NodeListenerSupport nodeListenerSupport = new NodeListenerSupport();
 
        /** All nodes. */
-       private List<Node> nodes = Collections.synchronizedList(new ArrayList<Node>());
+       private final List<Node> nodes = Collections.synchronizedList(new ArrayList<Node>());
 
        /** Map from node ID to node. */
-       private Map<String, Node> idNodes = Collections.synchronizedMap(new HashMap<String, Node>());
+       private final Map<String, Node> idNodes = Collections.synchronizedMap(new HashMap<String, Node>());
 
        /** All FCP connections. */
-       private Map<Node, HighLevelClient> nodeClients = Collections.synchronizedMap(new HashMap<Node, HighLevelClient>());
+       private final Map<Node, HighLevelClient> nodeClients = Collections.synchronizedMap(new HashMap<Node, HighLevelClient>());
 
        /** Maps nodes to high-level clients. */
-       private Map<HighLevelClient, Node> clientNodes = Collections.synchronizedMap(new HashMap<HighLevelClient, Node>());
+       private final Map<HighLevelClient, Node> clientNodes = Collections.synchronizedMap(new HashMap<HighLevelClient, Node>());
+
+       /** Collection of currently connected nodes. */
+       private final Set<Node> connectedNodes = Collections.synchronizedSet(new HashSet<Node>());
 
        /**
         * Creates a new FCP collector.
-        * 
+        *
         * @param clientName
         *            The name of the FCP client
         * @param directory
@@ -100,92 +103,22 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Adds the given listener to the list of listeners.
-        * 
+        *
         * @param nodeListener
         *            The listener to add
         */
        public void addNodeListener(NodeListener nodeListener) {
-               nodeListeners.add(nodeListener);
+               nodeListenerSupport.addListener(nodeListener);
        }
 
        /**
         * Removes the given listener from the list of listeners.
-        * 
+        *
         * @param nodeListener
         *            The listener to remove
         */
        public void removeNodeListener(NodeListener nodeListener) {
-               nodeListeners.remove(nodeListener);
-       }
-
-       /**
-        * Notifies all listeners that a node was added.
-        * 
-        * @param node
-        *            The node that was added.
-        */
-       private void fireNodeAdded(Node node) {
-               logger.finest("firing nodeAdded event with [node=" + node + "]");
-               for (NodeListener nodeListener : nodeListeners) {
-                       nodeListener.nodeAdded(node);
-               }
-       }
-
-       /**
-        * Notifies all listeners that a node was removed.
-        * 
-        * @param node
-        *            The node that was removed
-        */
-       private void fireNodeRemoved(Node node) {
-               logger.finest("firing nodeRemoved event with [node=" + node + "]");
-               for (NodeListener nodeListener : nodeListeners) {
-                       nodeListener.nodeRemoved(node);
-               }
-       }
-
-       /**
-        * Notifies all listeners that the given node was connected.
-        * 
-        * @param node
-        *            The node that is now connected
-        */
-       private void fireNodeConnected(Node node) {
-               logger.finest("firing nodeConnected event with [node=" + node + "]");
-               for (NodeListener nodeListener : nodeListeners) {
-                       nodeListener.nodeConnected(node);
-               }
-       }
-
-       /**
-        * Notifies all listeners that a connection to a node has failed.
-        * 
-        * @param node
-        *            The node that could not be connected
-        * @param cause
-        *            The cause of the failure
-        */
-       private void fireNodeConnectionFailed(Node node, Throwable cause) {
-               logger.finest("firing nodeConnectionFailed event with [node=" + node + ",cause=" + cause + "]");
-               for (NodeListener nodeListener : nodeListeners) {
-                       nodeListener.nodeConnectionFailed(node, cause);
-               }
-       }
-
-       /**
-        * Notifies all listeners that the given node was disconnected.
-        * 
-        * @param node
-        *            The node that is now disconnected
-        * @param throwable
-        *            The exception that caused the disconnect, or <code>null</code>
-        *            if there was no exception
-        */
-       private void fireNodeDisconnected(Node node, Throwable throwable) {
-               logger.finest("firing nodeDisconnected event with [node=" + node + ",throwable=" + throwable + "]");
-               for (NodeListener nodeListener : nodeListeners) {
-                       nodeListener.nodeDisconnected(node, throwable);
-               }
+               nodeListenerSupport.removeListener(nodeListener);
        }
 
        //
@@ -194,7 +127,7 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Returns the directory in which the nodes are stored.
-        * 
+        *
         * @return The directory the nodes are stored in
         */
        public String getDirectory() {
@@ -203,7 +136,7 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Checks whether the given node is already connected.
-        * 
+        *
         * @param node
         *            The node to check
         * @return <code>true</code> if the node is already connected,
@@ -226,12 +159,12 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Loads nodes.
-        * 
+        *
         * @throws IOException
         *             if an I/O error occurs loading the nodes
         */
        public void load() throws IOException {
-               logger.finest("load()");
+               logger.log(Level.FINEST, "load()");
                File directoryFile = new File(directory);
                File nodeFile = new File(directoryFile, "nodes.properties");
                if (!nodeFile.exists() || !nodeFile.isFile() || !nodeFile.canRead()) {
@@ -283,7 +216,7 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
                        newNode.setPort(nodePort);
                        loadedNodes.add(newNode);
                }
-               logger.fine("loaded " + loadedNodes.size() + " nodes from config");
+               logger.log(Level.FINE, "loaded " + loadedNodes.size() + " nodes from config");
                synchronized (syncObject) {
                        nodes.clear();
                        for (Node node : loadedNodes) {
@@ -294,12 +227,12 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Saves all configured nodes.
-        * 
+        *
         * @throws IOException
         *             if an I/O error occurs saving the nodes
         */
        public void save() throws IOException {
-               logger.finest("save()");
+               logger.log(Level.FINEST, "save()");
                File directoryFile = new File(directory);
                if (!directoryFile.exists()) {
                        if (!directoryFile.mkdirs()) {
@@ -327,17 +260,17 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Adds the given node to this manager.
-        * 
+        *
         * @see #connect(Node)
         * @param node
         *            The node to connect to
-        * @return <code>true</code> if the node was added, <code>false</code>
-        *         if the node was not added because it was already known
+        * @return <code>true</code> if the node was added, <code>false</code> if
+        *         the node was not added because it was already known
         */
        public boolean addNode(Node node) {
-               logger.finest("addNode(node=" + node + ")");
+               logger.log(Level.FINEST, "addNode(node=" + node + ")");
                if (nodes.contains(node)) {
-                       logger.warning("was told to add already known node: " + node);
+                       logger.log(Level.WARNING, "was told to add already known node: " + node);
                        return false;
                }
                node.addPropertyChangeListener(this);
@@ -347,19 +280,19 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
                clientNodes.put(highLevelClient, node);
                nodeClients.put(node, highLevelClient);
                highLevelClient.addHighLevelClientListener(this);
-               fireNodeAdded(node);
+               nodeListenerSupport.fireNodeAdded(node);
                return true;
        }
 
        /**
         * Removes the given node from the node manager, disconnecting it if it is
         * currently connected.
-        * 
+        *
         * @param node
         *            The node to remove
         */
        public void removeNode(Node node) {
-               logger.finest("removeNode(node=" + node + ")");
+               logger.log(Level.FINEST, "removeNode(node=" + node + ")");
                synchronized (syncObject) {
                        if (!nodes.contains(node)) {
                                return;
@@ -370,41 +303,41 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
                        nodes.remove(node);
                        idNodes.remove(node.getId());
                        node.removePropertyChangeListener(this);
-                       fireNodeRemoved(node);
+                       nodeListenerSupport.fireNodeRemoved(node);
                }
        }
 
        /**
         * Tries to establish a connection with the given node.
-        * 
+        *
         * @param node
         *            The node to connect to
         */
        public void connect(Node node) {
-               logger.finest("connect(node=" + node + ")");
+               logger.log(Level.FINEST, "connect(node=" + node + ")");
                HighLevelClient highLevelClient;
                highLevelClient = nodeClients.get(node);
                if (highLevelClient == null) {
-                       logger.warning("was told to connect to unknown node: " + node);
+                       logger.log(Level.WARNING, "was told to connect to unknown node: " + node);
                        return;
                }
                try {
                        highLevelClient.connect(node.getHostname(), node.getPort());
                } catch (UnknownHostException uhe1) {
-                       fireNodeConnectionFailed(node, uhe1);
+                       nodeListenerSupport.fireNodeConnectionFailed(node, uhe1);
                } catch (IOException ioe1) {
-                       fireNodeConnectionFailed(node, ioe1);
+                       nodeListenerSupport.fireNodeConnectionFailed(node, ioe1);
                }
        }
 
        /**
         * Disconnects the given node without removing it.
-        * 
+        *
         * @param node
         *            The node to disconnect
         */
        public void disconnect(Node node) {
-               logger.finest("disconnect(node=" + node + ")");
+               logger.log(Level.FINEST, "disconnect(node=" + node + ")");
                synchronized (syncObject) {
                        if (!nodes.contains(node)) {
                                return;
@@ -416,7 +349,7 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Returns a list of all nodes.
-        * 
+        *
         * @return A list of all nodes
         */
        public List<Node> getNodes() {
@@ -425,7 +358,7 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Returns the high-level client for a given node.
-        * 
+        *
         * @param node
         *            The node to get a high-level client for
         * @return The high-level client for a node, or <code>null</code> if the
@@ -437,7 +370,7 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Returns the node for a high-level client.
-        * 
+        *
         * @param highLevelClient
         *            The high-level client to get the node for
         * @return The node for the high-level client, or <code>null</code> if the
@@ -449,11 +382,11 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Returns the node identified by the given ID.
-        * 
+        *
         * @param id
         *            The ID of the node
-        * @return The node with the given ID, or <code>null</code> if no such
-        *         node was found
+        * @return The node with the given ID, or <code>null</code> if no such node
+        *         was found
         */
        Node getNode(String id) {
                return idNodes.get(id);
@@ -461,7 +394,7 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
 
        /**
         * Generates a new SSK key pair.
-        * 
+        *
         * @return An array with the private key at index <code>0</code> and the
         *         public key at index <code>1</code>
         * @throws IOException
@@ -470,7 +403,7 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
         *             if there is a problem with the node
         */
        public String[] generateKeyPair() throws IOException, JSiteException {
-               logger.finest("generateKeyPair()");
+               logger.log(Level.FINEST, "generateKeyPair()");
                if (nodes.isEmpty()) {
                        throw new NoNodeException("no node configured");
                }
@@ -499,27 +432,27 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
         * {@inheritDoc}
         */
        public void clientConnected(HighLevelClient highLevelClient) {
-               logger.finest("clientConnected(highLevelClient=" + highLevelClient + ")");
+               logger.log(Level.FINEST, "clientConnected(highLevelClient=" + highLevelClient + ")");
                Node node = clientNodes.get(highLevelClient);
                if (node == null) {
                        logger.log(Level.WARNING, "got event for unknown client");
                        return;
                }
-               fireNodeConnected(node);
+               nodeListenerSupport.fireNodeConnected(node);
        }
 
        /**
         * {@inheritDoc}
         */
        public void clientDisconnected(HighLevelClient highLevelClient, Throwable throwable) {
-               logger.finest("clientDisconnected(highLevelClient=" + highLevelClient + ",throwable=" + throwable + ")");
+               logger.log(Level.FINEST, "clientDisconnected(highLevelClient=" + highLevelClient + ",throwable=" + throwable + ")");
                synchronized (syncObject) {
                        Node node = clientNodes.get(highLevelClient);
                        if (node == null) {
                                logger.log(Level.WARNING, "got event for unknown client");
                                return;
                        }
-                       fireNodeDisconnected(node, throwable);
+                       nodeListenerSupport.fireNodeDisconnected(node, throwable);
                }
        }
 
@@ -546,9 +479,9 @@ public class NodeManager implements Iterable<Node>, PropertyChangeListener, High
                                        try {
                                                highLevelClient.connect(node.getHostname(), node.getPort());
                                        } catch (UnknownHostException uhe1) {
-                                               fireNodeConnectionFailed(node, uhe1);
+                                               nodeListenerSupport.fireNodeConnectionFailed(node, uhe1);
                                        } catch (IOException ioe1) {
-                                               fireNodeConnectionFailed(node, ioe1);
+                                               nodeListenerSupport.fireNodeConnectionFailed(node, ioe1);
                                        }
                                }
                        }