add high-level client listener
[jFCPlib.git] / src / net / pterodactylus / fcp / highlevel / HighLevelClient.java
index 0ec6da6..f1b3598 100644 (file)
@@ -27,8 +27,10 @@ import java.io.IOException;
 import java.net.InetAddress;
 import java.net.URL;
 import java.net.UnknownHostException;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.logging.Logger;
@@ -85,7 +87,7 @@ import net.pterodactylus.fcp.UnknownPeerNoteType;
 /**
  * A high-level client that allows simple yet full-featured access to a Freenet
  * node.
- * 
+ *
  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
  * @version $Id$
  */
@@ -109,6 +111,9 @@ public class HighLevelClient {
        /** The FCP connection to the node. */
        private FcpConnection fcpConnection;
 
+       /** Listeners for high-level client events. */
+       private List<HighLevelClientListener> highLevelClientListeners = Collections.synchronizedList(new ArrayList<HighLevelClientListener>());
+
        /** The listener for the connection. */
        private HighLevelClientFcpListener highLevelClientFcpListener = new HighLevelClientFcpListener();
 
@@ -133,7 +138,7 @@ public class HighLevelClient {
        /**
         * Creates a new high-level client that connects to a node on
         * <code>localhost</code>.
-        * 
+        *
         * @param clientName
         *            The name of the client
         * @throws UnknownHostException
@@ -146,7 +151,7 @@ public class HighLevelClient {
        /**
         * Creates a new high-level client that connects to a node on the given
         * host.
-        * 
+        *
         * @param clientName
         *            The name of the client
         * @param host
@@ -161,7 +166,7 @@ public class HighLevelClient {
        /**
         * Creates a new high-level client that connects to a node on the given
         * host.
-        * 
+        *
         * @param clientName
         *            The name of the client
         * @param host
@@ -178,7 +183,7 @@ public class HighLevelClient {
        /**
         * Creates a new high-level client that connects to a node at the given
         * address.
-        * 
+        *
         * @param clientName
         *            The name of the client
         * @param address
@@ -193,16 +198,69 @@ public class HighLevelClient {
        }
 
        //
+       // EVENT MANAGEMENT
+       //
+
+       /**
+        * Adds the given high-level client listener to list of listeners.
+        *
+        * @param highLevelClientListener
+        *            The listener to add
+        */
+       public void addHighLevelClientListener(HighLevelClientListener highLevelClientListener) {
+               highLevelClientListeners.add(highLevelClientListener);
+       }
+
+       /**
+        * Removes the given high-level client listener from the list of listeners.
+        *
+        * @param highLevelClientListener
+        *            The listener to remove
+        */
+       public void removeHighLevelClientListener(HighLevelClientListener highLevelClientListener) {
+               highLevelClientListeners.remove(highLevelClientListener);
+       }
+
+       /**
+        * Notifies all listeners that a client has connected.
+        */
+       private void fireClientConnected() {
+               for (HighLevelClientListener highLevelClientListener: highLevelClientListeners) {
+                       highLevelClientListener.clientConnected(this);
+               }
+       }
+
+       /**
+        * Notifies all listeners that a client has disconnected.
+        */
+       private void fireClientDisconnected() {
+               for (HighLevelClientListener highLevelClientListener: highLevelClientListeners) {
+                       highLevelClientListener.clientDisconnected(this);
+               }
+       }
+
+       //
        // ACCESSORS
        //
 
+       /**
+        * Returns the FCP connection that backs this high-level client. This method
+        * should be used with care as fiddling around with the FCP connection can
+        * easily break the high-level client if you don’t know what you’re doing!
+        *
+        * @return The FCP connection of this client
+        */
+       public FcpConnection getFcpConnection() {
+               return fcpConnection;
+       }
+
        //
        // ACTIONS
        //
 
        /**
         * Connects the client.
-        * 
+        *
         * @return A callback with a connection result
         * @throws IOException
         *             if an I/O error occurs communicating with the node
@@ -220,11 +278,13 @@ public class HighLevelClient {
         * Disconnects the client from the node.
         */
        public void disconnect() {
+               fcpConnection.close();
+               fireClientDisconnected();
        }
 
        /**
         * Generates a new SSK keypair.
-        * 
+        *
         * @return A callback with the keypair
         * @throws IOException
         *             if an I/O error occurs communicating with the node
@@ -240,7 +300,7 @@ public class HighLevelClient {
 
        /**
         * Gets a list of all peers from the node.
-        * 
+        *
         * @return A callback with the peer list
         * @throws IOException
         *             if an I/O error occurs with the node
@@ -256,7 +316,7 @@ public class HighLevelClient {
 
        /**
         * Adds the peer whose noderef is stored in the given file.
-        * 
+        *
         * @param nodeRefFile
         *            The name of the file the peer’s noderef is stored in
         * @return A peer callback
@@ -274,7 +334,7 @@ public class HighLevelClient {
 
        /**
         * Adds the peer whose noderef is stored in the given file.
-        * 
+        *
         * @param nodeRefURL
         *            The URL where the peer’s noderef is stored
         * @return A peer callback
@@ -292,7 +352,7 @@ public class HighLevelClient {
 
        /**
         * Adds the peer whose noderef is stored in the given file.
-        * 
+        *
         * @param nodeRef
         *            The peer’s noderef
         * @return A peer callback
@@ -312,7 +372,7 @@ public class HighLevelClient {
         * Checks whether direct disk access for the given directory is possible.
         * You have to perform this check before you can upload or download anything
         * from or the disk directly!
-        * 
+        *
         * @param directory
         *            The directory to check
         * @param wantRead
@@ -334,7 +394,7 @@ public class HighLevelClient {
         * Starts a download. Files can either be download to disk or streamed from
         * the node. When downloading to disk you have to perform a direct disk
         * access check for the directory you want to put the downloaded file in!
-        * 
+        *
         * @see #checkDirectDiskAccess(String, boolean, boolean)
         * @param uri
         *            The URI to get
@@ -364,7 +424,7 @@ public class HighLevelClient {
 
        /**
         * Generates an identifier for the given function.
-        * 
+        *
         * @param function
         *            The name of the function
         * @return An identifier
@@ -375,7 +435,7 @@ public class HighLevelClient {
 
        /**
         * FCP listener for {@link HighLevelClient}.
-        * 
+        *
         * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
         * @version $Id$
         */
@@ -388,6 +448,7 @@ public class HighLevelClient {
                 * Creates a new FCP listener for {@link HighLevelClient}.
                 */
                HighLevelClientFcpListener() {
+                       /* do nothing. */
                }
 
                //
@@ -397,7 +458,7 @@ public class HighLevelClient {
                /**
                 * Searches all callback collections for a callback with the given
                 * identifier and cancels it.
-                * 
+                *
                 * @param identifier
                 *            The identifier to search for, or <code>null</code> to
                 *            cancel all pending requests
@@ -478,7 +539,7 @@ public class HighLevelClient {
 
                /**
                 * Reads the given file and returns the first line of the file.
-                * 
+                *
                 * @param readFilename
                 *            The name of the file to read
                 * @return The content of the file
@@ -502,7 +563,7 @@ public class HighLevelClient {
 
                /**
                 * Writes the given content to the given file.
-                * 
+                *
                 * @param directDiskAccessResult
                 *            The DDA result
                 * @param writeFilename
@@ -528,7 +589,7 @@ public class HighLevelClient {
 
                /**
                 * Cleans up any files that written for the given result.
-                * 
+                *
                 * @param directDiskAccessResult
                 *            The direct disk access result
                 */
@@ -562,6 +623,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.AllData)
                 */
                public void receivedAllData(FcpConnection fcpConnection, AllData allData) {
+                       /* TODO */
                }
 
                /**
@@ -569,6 +631,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.CloseConnectionDuplicateClientName)
                 */
                public void receivedCloseConnectionDuplicateClientName(FcpConnection fcpConnection, CloseConnectionDuplicateClientName closeConnectionDuplicateClientName) {
+                       /* TODO */
                }
 
                /**
@@ -576,6 +639,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.ConfigData)
                 */
                public void receivedConfigData(FcpConnection fcpConnection, ConfigData configData) {
+                       /* TODO */
                }
 
                /**
@@ -583,6 +647,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.DataFound)
                 */
                public void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound) {
+                       /* TODO */
                }
 
                /**
@@ -590,6 +655,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.EndListPeerNotes)
                 */
                public void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) {
+                       /* TODO */
                }
 
                /**
@@ -614,6 +680,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.EndListPersistentRequests)
                 */
                public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) {
+                       /* TODO */
                }
 
                /**
@@ -621,6 +688,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.FCPPluginReply)
                 */
                public void receivedFCPPluginReply(FcpConnection fcpConnection, FCPPluginReply fcpPluginReply) {
+                       /* TODO */
                }
 
                /**
@@ -648,6 +716,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.IdentifierCollision)
                 */
                public void receivedIdentifierCollision(FcpConnection fcpConnection, IdentifierCollision identifierCollision) {
+                       /* TODO */
                }
 
                /**
@@ -655,6 +724,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.FcpMessage)
                 */
                public void receivedMessage(FcpConnection fcpConnection, FcpMessage fcpMessage) {
+                       /* TODO */
                }
 
                /**
@@ -662,6 +732,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.NodeData)
                 */
                public void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) {
+                       /* TODO */
                }
 
                /**
@@ -678,6 +749,7 @@ public class HighLevelClient {
                                connectCallback.setDone();
                                connectCallback = null;
                        }
+                       fireClientConnected();
                }
 
                /**
@@ -712,6 +784,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PeerNote)
                 */
                public void receivedPeerNote(FcpConnection fcpConnection, PeerNote peerNote) {
+                       /* TODO */
                }
 
                /**
@@ -719,6 +792,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PeerRemoved)
                 */
                public void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) {
+                       /* TODO */
                }
 
                /**
@@ -742,6 +816,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PersistentPut)
                 */
                public void receivedPersistentPut(FcpConnection fcpConnection, PersistentPut persistentPut) {
+                       /* TODO */
                }
 
                /**
@@ -749,6 +824,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PersistentPutDir)
                 */
                public void receivedPersistentPutDir(FcpConnection fcpConnection, PersistentPutDir persistentPutDir) {
+                       /* TODO */
                }
 
                /**
@@ -756,6 +832,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PersistentRequestModified)
                 */
                public void receivedPersistentRequestModified(FcpConnection fcpConnection, PersistentRequestModified persistentRequestModified) {
+                       /* TODO */
                }
 
                /**
@@ -763,6 +840,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PersistentRequestRemoved)
                 */
                public void receivedPersistentRequestRemoved(FcpConnection fcpConnection, PersistentRequestRemoved persistentRequestRemoved) {
+                       /* TODO */
                }
 
                /**
@@ -770,6 +848,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PluginInfo)
                 */
                public void receivedPluginInfo(FcpConnection fcpConnection, PluginInfo pluginInfo) {
+                       /* TODO */
                }
 
                /**
@@ -793,6 +872,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PutFailed)
                 */
                public void receivedPutFailed(FcpConnection fcpConnection, PutFailed putFailed) {
+                       /* TODO */
                }
 
                /**
@@ -800,6 +880,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PutFetchable)
                 */
                public void receivedPutFetchable(FcpConnection fcpConnection, PutFetchable putFetchable) {
+                       /* TODO */
                }
 
                /**
@@ -807,6 +888,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PutSuccessful)
                 */
                public void receivedPutSuccessful(FcpConnection fcpConnection, PutSuccessful putSuccessful) {
+                       /* TODO */
                }
 
                /**
@@ -859,6 +941,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.StartedCompression)
                 */
                public void receivedStartedCompression(FcpConnection fcpConnection, StartedCompression startedCompression) {
+                       /* TODO */
                }
 
                /**
@@ -866,6 +949,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.SubscribedUSKUpdate)
                 */
                public void receivedSubscribedUSKUpdate(FcpConnection fcpConnection, SubscribedUSKUpdate subscribedUSKUpdate) {
+                       /* TODO */
                }
 
                /**
@@ -921,6 +1005,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.URIGenerated)
                 */
                public void receivedURIGenerated(FcpConnection fcpConnection, URIGenerated uriGenerated) {
+                       /* TODO */
                }
 
                /**
@@ -928,6 +1013,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.UnknownNodeIdentifier)
                 */
                public void receivedUnknownNodeIdentifier(FcpConnection fcpConnection, UnknownNodeIdentifier unknownNodeIdentifier) {
+                       /* TODO */
                }
 
                /**
@@ -935,6 +1021,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.UnknownPeerNoteType)
                 */
                public void receivedUnknownPeerNoteType(FcpConnection fcpConnection, UnknownPeerNoteType unknownPeerNoteType) {
+                       /* TODO */
                }
 
                /**
@@ -942,6 +1029,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.FinishedCompression)
                 */
                public void receviedFinishedCompression(FcpConnection fcpConnection, FinishedCompression finishedCompression) {
+                       /* TODO */
                }
 
        }