throw exception if client is not connected
[jFCPlib.git] / src / net / pterodactylus / fcp / highlevel / HighLevelClient.java
index a09b289..e263454 100644 (file)
@@ -105,14 +105,8 @@ public class HighLevelClient {
        /** The name of the client. */
        private final String clientName;
 
-       /** The address of the node. */
-       private InetAddress address;
-
-       /** The port number of the node. */
-       private int port;
-
        /** The FCP connection to the node. */
-       private FcpConnection fcpConnection;
+       private FcpConnection fcpConnection = null;
 
        /** Listeners for high-level client events. */
        private List<HighLevelClientListener> highLevelClientListeners = Collections.synchronizedList(new ArrayList<HighLevelClientListener>());
@@ -123,7 +117,7 @@ public class HighLevelClient {
        /** The listeners for progress events. */
        private List<HighLevelProgressListener> highLevelProgressListeners = Collections.synchronizedList(new ArrayList<HighLevelProgressListener>());
 
-       /** The callback for {@link #connect()}. */
+       /** The callback for {@link #connect(String)}. */
        private HighLevelCallback<ConnectResult> connectCallback;
 
        /** Mapping from request identifiers to callbacks. */
@@ -150,60 +144,9 @@ public class HighLevelClient {
         * 
         * @param clientName
         *            The name of the client
-        * @throws UnknownHostException
-        *             if the hostname of the node can not be resolved.
-        */
-       public HighLevelClient(String clientName) throws UnknownHostException {
-               this(clientName, "localhost");
-       }
-
-       /**
-        * Creates a new high-level client that connects to a node on the given
-        * host.
-        * 
-        * @param clientName
-        *            The name of the client
-        * @param host
-        *            The hostname of the node
-        * @throws UnknownHostException
-        *             if the hostname of the node can not be resolved.
-        */
-       public HighLevelClient(String clientName, String host) throws UnknownHostException {
-               this(clientName, host, FcpConnection.DEFAULT_PORT);
-       }
-
-       /**
-        * Creates a new high-level client that connects to a node on the given
-        * host.
-        * 
-        * @param clientName
-        *            The name of the client
-        * @param host
-        *            The hostname of the node
-        * @param port
-        *            The port number of the node
-        * @throws UnknownHostException
-        *             if the hostname of the node can not be resolved.
-        */
-       public HighLevelClient(String clientName, String host, int port) throws UnknownHostException {
-               this(clientName, InetAddress.getByName(host), port);
-       }
-
-       /**
-        * Creates a new high-level client that connects to a node at the given
-        * address.
-        * 
-        * @param clientName
-        *            The name of the client
-        * @param address
-        *            The address of the node
-        * @param port
-        *            The port number of the node
         */
-       public HighLevelClient(String clientName, InetAddress address, int port) {
+       public HighLevelClient(String clientName) {
                this.clientName = clientName;
-               this.address = address;
-               this.port = port;
        }
 
        //
@@ -234,7 +177,7 @@ public class HighLevelClient {
         * Notifies all listeners that a client has connected.
         */
        private void fireClientConnected() {
-               for (HighLevelClientListener highLevelClientListener: highLevelClientListeners) {
+               for (HighLevelClientListener highLevelClientListener : highLevelClientListeners) {
                        highLevelClientListener.clientConnected(this);
                }
        }
@@ -247,7 +190,7 @@ public class HighLevelClient {
         *            if there was no exception
         */
        private void fireClientDisconnected(Throwable throwable) {
-               for (HighLevelClientListener highLevelClientListener: highLevelClientListeners) {
+               for (HighLevelClientListener highLevelClientListener : highLevelClientListeners) {
                        highLevelClientListener.clientDisconnected(this, throwable);
                }
        }
@@ -282,8 +225,8 @@ public class HighLevelClient {
         *            The progress of the request
         */
        private void fireProgressReceived(String identifier, HighLevelProgress highLevelProgress) {
-               for (HighLevelProgressListener highLevelProgressListener: highLevelProgressListeners) {
-                       highLevelProgressListener.progressReceived(identifier, highLevelProgress);
+               for (HighLevelProgressListener highLevelProgressListener : highLevelProgressListeners) {
+                       highLevelProgressListener.progressReceived(this, identifier, highLevelProgress);
                }
        }
 
@@ -302,6 +245,16 @@ public class HighLevelClient {
                return fcpConnection;
        }
 
+       /**
+        * Returns whether the node is connected.
+        * 
+        * @return <code>true</code> if the node is currently connected,
+        *         <code>false</code> otherwise
+        */
+       public boolean isConnected() {
+               return fcpConnection != null;
+       }
+
        //
        // ACTIONS
        //
@@ -309,18 +262,61 @@ public class HighLevelClient {
        /**
         * Connects the client.
         * 
+        * @param hostname
+        *            The hostname of the node
         * @return A callback with a connection result
+        * @throws UnknownHostException
+        *             if the hostname can not be resolved
+        * @throws IOException
+        *             if an I/O error occurs communicating with the node
+        */
+       public HighLevelCallback<ConnectResult> connect(String hostname) throws UnknownHostException, IOException {
+               return connect(hostname, 9481);
+       }
+
+       /**
+        * Connects the client.
+        * 
+        * @param hostname
+        *            The hostname of the node
+        * @param port
+        *            The port number of the node
+        * @return A callback with a connection result
+        * @throws UnknownHostException
+        *             if the hostname can not be resolved
         * @throws IOException
         *             if an I/O error occurs communicating with the node
         */
-       public HighLevelCallback<ConnectResult> connect() throws IOException {
-               fcpConnection = new FcpConnection(address, port);
-               fcpConnection.addFcpListener(highLevelClientFcpListener);
-               fcpConnection.connect();
-               ClientHello clientHello = new ClientHello(clientName);
-               connectCallback = new HighLevelCallback<ConnectResult>(new ConnectResult());
-               fcpConnection.sendMessage(clientHello);
-               return connectCallback;
+       public HighLevelCallback<ConnectResult> connect(String hostname, int port) throws UnknownHostException, IOException {
+               return connect(InetAddress.getByName(hostname), port);
+       }
+
+       /**
+        * Connects the client.
+        * 
+        * @param address
+        *            The address of the node
+        * @param port
+        *            The port number of the node
+        * @return A callback with a connection result
+        * @throws IOException
+        *             if an I/O error occurs communicating with the node
+        */
+       public HighLevelCallback<ConnectResult> connect(InetAddress address, int port) throws IOException {
+               try {
+                       synchronized (this) {
+                               fcpConnection = new FcpConnection(address, port);
+                       }
+                       fcpConnection.addFcpListener(highLevelClientFcpListener);
+                       fcpConnection.connect();
+                       ClientHello clientHello = new ClientHello(clientName);
+                       connectCallback = new HighLevelCallback<ConnectResult>(new ConnectResult());
+                       fcpConnection.sendMessage(clientHello);
+                       return connectCallback;
+               } catch (IOException ioe1) {
+                       fcpConnection = null;
+                       throw ioe1;
+               }
        }
 
        /**
@@ -336,8 +332,11 @@ public class HighLevelClient {
         * @return A callback with the keypair
         * @throws IOException
         *             if an I/O error occurs communicating with the node
+        * @throws HighLevelException
+        *             if the client is not connected
         */
-       public HighLevelCallback<KeyGenerationResult> generateKey() throws IOException {
+       public HighLevelCallback<KeyGenerationResult> generateKey() throws IOException, HighLevelException {
+               checkConnection();
                String identifier = generateIdentifier("generateSSK");
                GenerateSSK generateSSK = new GenerateSSK(identifier);
                HighLevelCallback<KeyGenerationResult> keyGenerationCallback = new HighLevelCallback<KeyGenerationResult>(new KeyGenerationResult(identifier));
@@ -355,8 +354,11 @@ public class HighLevelClient {
         *            client-local queue
         * @throws IOException
         *             if an I/O error occurs communicating with the node
+        * @throws HighLevelException
+        *             if the client is not connected
         */
-       public void setWatchGlobal(boolean enabled) throws IOException {
+       public void setWatchGlobal(boolean enabled) throws IOException, HighLevelException {
+               checkConnection();
                WatchGlobal watchGlobal = new WatchGlobal(enabled);
                fcpConnection.sendMessage(watchGlobal);
        }
@@ -367,8 +369,11 @@ public class HighLevelClient {
         * @return A callback with the peer list
         * @throws IOException
         *             if an I/O error occurs with the node
+        * @throws HighLevelException
+        *             if the client is not connected
         */
-       public HighLevelCallback<PeerListResult> getPeers() throws IOException {
+       public HighLevelCallback<PeerListResult> getPeers() throws IOException, HighLevelException {
+               checkConnection();
                String identifier = generateIdentifier("listPeers");
                ListPeers listPeers = new ListPeers(identifier, true, true);
                HighLevelCallback<PeerListResult> peerListCallback = new HighLevelCallback<PeerListResult>(new PeerListResult(identifier));
@@ -385,8 +390,11 @@ public class HighLevelClient {
         * @return A peer callback
         * @throws IOException
         *             if an I/O error occurs communicating with the node
+        * @throws HighLevelException
+        *             if the client is not connected
         */
-       public HighLevelCallback<PeerResult> addPeer(String nodeRefFile) throws IOException {
+       public HighLevelCallback<PeerResult> addPeer(String nodeRefFile) throws IOException, HighLevelException {
+               checkConnection();
                String identifier = generateIdentifier("addPeer");
                AddPeer addPeer = new AddPeer(nodeRefFile);
                HighLevelCallback<PeerResult> peerCallback = new HighLevelCallback<PeerResult>(new PeerResult(identifier));
@@ -403,8 +411,11 @@ public class HighLevelClient {
         * @return A peer callback
         * @throws IOException
         *             if an I/O error occurs communicating with the node
+        * @throws HighLevelException
+        *             if the client is not connected
         */
-       public HighLevelCallback<PeerResult> addPeer(URL nodeRefURL) throws IOException {
+       public HighLevelCallback<PeerResult> addPeer(URL nodeRefURL) throws IOException, HighLevelException {
+               checkConnection();
                String identifier = generateIdentifier("addPeer");
                AddPeer addPeer = new AddPeer(nodeRefURL);
                HighLevelCallback<PeerResult> peerCallback = new HighLevelCallback<PeerResult>(new PeerResult(identifier));
@@ -421,8 +432,11 @@ public class HighLevelClient {
         * @return A peer callback
         * @throws IOException
         *             if an I/O error occurs communicating with the node
+        * @throws HighLevelException
+        *             if the client is not connected
         */
-       public HighLevelCallback<PeerResult> addPeer(NodeRef nodeRef) throws IOException {
+       public HighLevelCallback<PeerResult> addPeer(NodeRef nodeRef) throws IOException, HighLevelException {
+               checkConnection();
                String identifier = generateIdentifier("addPeer");
                AddPeer addPeer = new AddPeer(nodeRef);
                HighLevelCallback<PeerResult> peerCallback = new HighLevelCallback<PeerResult>(new PeerResult(identifier));
@@ -444,8 +458,12 @@ public class HighLevelClient {
         *            Whether you want to write to the given directory
         * @return A direct disk access callback
         * @throws IOException
+        *             if an I/O error occurs communicating with the node
+        * @throws HighLevelException
+        *             if the client is not connected
         */
-       public HighLevelCallback<DirectDiskAccessResult> checkDirectDiskAccess(String directory, boolean wantRead, boolean wantWrite) throws IOException {
+       public HighLevelCallback<DirectDiskAccessResult> checkDirectDiskAccess(String directory, boolean wantRead, boolean wantWrite) throws IOException, HighLevelException {
+               checkConnection();
                TestDDARequest testDDARequest = new TestDDARequest(directory, wantRead, wantWrite);
                HighLevelCallback<DirectDiskAccessResult> directDiskAccessCallback = new HighLevelCallback<DirectDiskAccessResult>(new DirectDiskAccessResult(directory));
                directDiskAccessCallbacks.put(directory, directDiskAccessCallback);
@@ -470,8 +488,11 @@ public class HighLevelClient {
         * @return A download result
         * @throws IOException
         *             if an I/O error occurs communicating with the node
+        * @throws HighLevelException
+        *             if the client is not connected
         */
-       public HighLevelProgressCallback<DownloadResult> download(String uri, String filename, boolean global) throws IOException {
+       public HighLevelProgressCallback<DownloadResult> download(String uri, String filename, boolean global) throws IOException, HighLevelException {
+               checkConnection();
                String identifier = generateIdentifier("download");
                ClientGet clientGet = new ClientGet(uri, identifier, (filename == null) ? ReturnType.direct : ReturnType.disk);
                clientGet.setGlobal(global);
@@ -487,8 +508,11 @@ public class HighLevelClient {
         * @return The request list result
         * @throws IOException
         *             if an I/O errors communicating with the node
+        * @throws HighLevelException
+        *             if the client is not connected
         */
-       public HighLevelCallback<RequestListResult> getRequests() throws IOException {
+       public HighLevelCallback<RequestListResult> getRequests() throws IOException, HighLevelException {
+               checkConnection();
                String identifier = generateIdentifier("list-persistent-requests");
                ListPersistentRequests listPersistentRequests = new ListPersistentRequests();
                synchronized (syncObject) {
@@ -506,6 +530,21 @@ public class HighLevelClient {
        //
 
        /**
+        * Checks whether the client is already connected and throws an exception if
+        * it is not.
+        * 
+        * @throws HighLevelException
+        *             if the client is not connected
+        */
+       private void checkConnection() throws HighLevelException {
+               synchronized (this) {
+                       if (fcpConnection == null) {
+                               throw new HighLevelException("client is not connected");
+                       }
+               }
+       }
+
+       /**
         * Generates an identifier for the given function.
         * 
         * @param function
@@ -525,8 +564,10 @@ public class HighLevelClient {
         *            if there was no exception
         */
        private void disconnect(Throwable throwable) {
-               fcpConnection.close();
-               fireClientDisconnected(throwable);
+               if (fcpConnection != null) {
+                       fcpConnection.close();
+               }
+               fcpConnection = null;
        }
 
        /**
@@ -575,31 +616,31 @@ public class HighLevelClient {
                        }
                        if (identifier == null) {
                                /* key generation callbacks */
-                               for (Entry<String, HighLevelCallback<KeyGenerationResult>> keyGenerationEntry: keyGenerationCallbacks.entrySet()) {
+                               for (Entry<String, HighLevelCallback<KeyGenerationResult>> keyGenerationEntry : keyGenerationCallbacks.entrySet()) {
                                        keyGenerationEntry.getValue().getIntermediaryResult().setFailed(true);
                                        keyGenerationEntry.getValue().setDone();
                                }
                                keyGenerationCallbacks.clear();
                                /* peer list callbacks. */
-                               for (Entry<String, HighLevelCallback<PeerListResult>> peerListEntry: peerListCallbacks.entrySet()) {
+                               for (Entry<String, HighLevelCallback<PeerListResult>> peerListEntry : peerListCallbacks.entrySet()) {
                                        peerListEntry.getValue().getIntermediaryResult().setFailed(true);
                                        peerListEntry.getValue().setDone();
                                }
                                peerListCallbacks.clear();
                                /* peer callbacks. */
-                               for (Entry<String, HighLevelCallback<PeerResult>> peerEntry: peerCallbacks.entrySet()) {
+                               for (Entry<String, HighLevelCallback<PeerResult>> peerEntry : peerCallbacks.entrySet()) {
                                        peerEntry.getValue().getIntermediaryResult().setFailed(true);
                                        peerEntry.getValue().setDone();
                                }
                                peerCallbacks.clear();
                                /* direct disk access callbacks. */
-                               for (Entry<String, HighLevelCallback<DirectDiskAccessResult>> directDiskAccessEntry: directDiskAccessCallbacks.entrySet()) {
+                               for (Entry<String, HighLevelCallback<DirectDiskAccessResult>> directDiskAccessEntry : directDiskAccessCallbacks.entrySet()) {
                                        directDiskAccessEntry.getValue().getIntermediaryResult().setFailed(true);
                                        directDiskAccessEntry.getValue().setDone();
                                }
                                directDiskAccessCallbacks.clear();
                                /* download callbacks. */
-                               for (Entry<String, HighLevelProgressCallback<DownloadResult>> downloadEntry: downloadCallbacks.entrySet()) {
+                               for (Entry<String, HighLevelProgressCallback<DownloadResult>> downloadEntry : downloadCallbacks.entrySet()) {
                                        downloadEntry.getValue().getIntermediaryResult().setFailed(true);
                                        downloadEntry.getValue().setDone();
                                }
@@ -719,6 +760,7 @@ public class HighLevelClient {
                        }
                        cancelIdentifier(null);
                        disconnect(throwable);
+                       fireClientDisconnected(throwable);
                }
 
                /**
@@ -1071,7 +1113,6 @@ public class HighLevelClient {
                                downloadResult.setFatallyFailedBlocks(simpleProgress.getFatallyFailed());
                                downloadResult.setTotalFinalized(simpleProgress.isFinalizedTotal());
                                downloadCallback.progressUpdated();
-                               return;
                        }
                        HighLevelProgress highLevelProgress = new HighLevelProgress(identifier, simpleProgress.getTotal(), simpleProgress.getRequired(), simpleProgress.getSucceeded(), simpleProgress.getFailed(), simpleProgress.getFatallyFailed(), simpleProgress.isFinalizedTotal());
                        fireProgressReceived(identifier, highLevelProgress);