X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fnet%2Fpterodactylus%2Ffcp%2Fhighlevel%2FHighLevelClient.java;h=a347e68e53f6fb2253cb785470b7eef85766a8d5;hb=5f2cf2dc2269c59ad3fbcc0e8bdf822bbb6aed23;hp=5032eef269c4d16cb87324b5e18bdefd917a4b4c;hpb=e661a133eb50f60545cbb0b6ffb6b2f581155abe;p=jFCPlib.git diff --git a/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java b/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java index 5032eef..a347e68 100644 --- a/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java +++ b/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java @@ -33,6 +33,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Map.Entry; +import java.util.logging.Level; import java.util.logging.Logger; import net.pterodactylus.fcp.AddPeer; @@ -55,6 +56,7 @@ import net.pterodactylus.fcp.GenerateSSK; import net.pterodactylus.fcp.GetFailed; import net.pterodactylus.fcp.IdentifierCollision; import net.pterodactylus.fcp.ListPeers; +import net.pterodactylus.fcp.ListPersistentRequests; import net.pterodactylus.fcp.NodeData; import net.pterodactylus.fcp.NodeHello; import net.pterodactylus.fcp.NodeRef; @@ -83,11 +85,12 @@ import net.pterodactylus.fcp.TestDDAResponse; import net.pterodactylus.fcp.URIGenerated; import net.pterodactylus.fcp.UnknownNodeIdentifier; import net.pterodactylus.fcp.UnknownPeerNoteType; +import net.pterodactylus.fcp.WatchGlobal; /** * A high-level client that allows simple yet full-featured access to a Freenet * node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> * @version $Id$ */ @@ -102,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 highLevelClientListeners = Collections.synchronizedList(new ArrayList()); @@ -117,7 +114,10 @@ public class HighLevelClient { /** The listener for the connection. */ private HighLevelClientFcpListener highLevelClientFcpListener = new HighLevelClientFcpListener(); - /** The callback for {@link #connect()}. */ + /** The listeners for progress events. */ + private List highLevelProgressListeners = Collections.synchronizedList(new ArrayList()); + + /** The callback for {@link #connect(String)}. */ private HighLevelCallback connectCallback; /** Mapping from request identifiers to callbacks. */ @@ -135,66 +135,18 @@ public class HighLevelClient { /** Mapping from request identifiers to download callbacks. */ private Map> downloadCallbacks = Collections.synchronizedMap(new HashMap>()); + /** The callback for {@link #getRequests()}. */ + private HighLevelCallback requestListCallback; + /** * Creates a new high-level client that connects to a node on * localhost. - * - * @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; } // @@ -203,7 +155,7 @@ public class HighLevelClient { /** * Adds the given high-level client listener to list of listeners. - * + * * @param highLevelClientListener * The listener to add */ @@ -213,7 +165,7 @@ public class HighLevelClient { /** * Removes the given high-level client listener from the list of listeners. - * + * * @param highLevelClientListener * The listener to remove */ @@ -232,7 +184,7 @@ public class HighLevelClient { /** * Notifies all listeners that a client has disconnected. - * + * * @param throwable * The exception that caused the disconnect, or null * if there was no exception @@ -243,6 +195,41 @@ public class HighLevelClient { } } + /** + * Adds a high-level progress listener. + * + * @param highLevelProgressListener + * The high-level progress listener to add + */ + public void addHighLevelProgressListener(HighLevelProgressListener highLevelProgressListener) { + highLevelProgressListeners.add(highLevelProgressListener); + } + + /** + * Removes a high-level progress listener. + * + * @param highLevelProgressListener + * The high-level progress listener to remove + */ + public void removeHighLevelProgressListener(HighLevelProgressListener highLevelProgressListener) { + highLevelProgressListeners.remove(highLevelProgressListener); + } + + /** + * Notifies all listeners that the request with the given identifier made + * some progress. + * + * @param identifier + * The identifier of the request + * @param highLevelProgress + * The progress of the request + */ + private void fireProgressReceived(String identifier, HighLevelProgress highLevelProgress) { + for (HighLevelProgressListener highLevelProgressListener: highLevelProgressListeners) { + highLevelProgressListener.progressReceived(this, identifier, highLevelProgress); + } + } + // // ACCESSORS // @@ -251,25 +238,71 @@ public class HighLevelClient { * 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; } + /** + * Returns whether the node is connected. + * + * @return true if the node is currently connected, + * false otherwise + */ + public boolean isConnected() { + return fcpConnection != null; + } + // // ACTIONS // /** * 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 connect() throws IOException { + public HighLevelCallback 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 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 connect(InetAddress address, int port) throws IOException { fcpConnection = new FcpConnection(address, port); fcpConnection.addFcpListener(highLevelClientFcpListener); fcpConnection.connect(); @@ -288,7 +321,7 @@ public class HighLevelClient { /** * Generates a new SSK keypair. - * + * * @return A callback with the keypair * @throws IOException * if an I/O error occurs communicating with the node @@ -303,8 +336,23 @@ public class HighLevelClient { } /** + * Sets whether to watch the global queue. + * + * @param enabled + * true to watch the global queue in addition to + * the client-local queue, false to only watch the + * client-local queue + * @throws IOException + * if an I/O error occurs communicating with the node + */ + public void setWatchGlobal(boolean enabled) throws IOException { + WatchGlobal watchGlobal = new WatchGlobal(enabled); + fcpConnection.sendMessage(watchGlobal); + } + + /** * 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 @@ -320,7 +368,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 @@ -338,7 +386,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 @@ -356,7 +404,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 @@ -376,7 +424,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 @@ -398,7 +446,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 @@ -422,13 +470,33 @@ public class HighLevelClient { return downloadCallback; } + /** + * Requests a list of all running requests from the node. + * + * @return The request list result + * @throws IOException + * if an I/O errors communicating with the node + */ + public HighLevelCallback getRequests() throws IOException { + String identifier = generateIdentifier("list-persistent-requests"); + ListPersistentRequests listPersistentRequests = new ListPersistentRequests(); + synchronized (syncObject) { + if (requestListCallback != null) { + logger.log(Level.SEVERE, "getRequests() called with request still running!"); + } + requestListCallback = new HighLevelCallback(new RequestListResult(identifier)); + } + fcpConnection.sendMessage(listPersistentRequests); + return requestListCallback; + } + // // PRIVATE METHODS // /** * Generates an identifier for the given function. - * + * * @param function * The name of the function * @return An identifier @@ -440,19 +508,21 @@ public class HighLevelClient { /** * Disconnects the client from the node, handing the given Throwable to * {@link #fireClientDisconnected(Throwable)}. - * + * * @param throwable * The exception that caused the disconnect, or null * if there was no exception */ private void disconnect(Throwable throwable) { - fcpConnection.close(); - fireClientDisconnected(throwable); + if (fcpConnection != null) { + fcpConnection.close(); + } + fcpConnection = null; } /** * FCP listener for {@link HighLevelClient}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> * @version $Id$ */ @@ -475,7 +545,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 null to * cancel all pending requests @@ -488,6 +558,11 @@ public class HighLevelClient { connectCallback.setDone(); connectCallback = null; } + if (requestListCallback != null) { + requestListCallback.getIntermediaryResult().setFailed(true); + requestListCallback.setDone(); + requestListCallback = null; + } } if (identifier == null) { /* key generation callbacks */ @@ -556,7 +631,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 @@ -580,7 +655,7 @@ public class HighLevelClient { /** * Writes the given content to the given file. - * + * * @param directDiskAccessResult * The DDA result * @param writeFilename @@ -606,7 +681,7 @@ public class HighLevelClient { /** * Cleans up any files that written for the given result. - * + * * @param directDiskAccessResult * The direct disk access result */ @@ -635,6 +710,7 @@ public class HighLevelClient { } cancelIdentifier(null); disconnect(throwable); + fireClientDisconnected(throwable); } /** @@ -698,8 +774,19 @@ public class HighLevelClient { * @see net.pterodactylus.fcp.FcpListener#receivedEndListPersistentRequests(net.pterodactylus.fcp.FcpConnection, * net.pterodactylus.fcp.EndListPersistentRequests) */ + @SuppressWarnings("synthetic-access") public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) { - /* TODO */ + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + synchronized (syncObject) { + if (HighLevelClient.this.requestListCallback == null) { + logger.log(Level.WARNING, "got EndListPersistentRequests without running request!"); + return; + } + requestListCallback.setDone(); + requestListCallback = null; + } } /** @@ -823,9 +910,16 @@ public class HighLevelClient { if (fcpConnection != HighLevelClient.this.fcpConnection) { return; } + synchronized (syncObject) { + if (requestListCallback != null) { + RequestListResult requestListResult = requestListCallback.getIntermediaryResult(); + requestListResult.addRequestResult(new GetRequestResult(persistentGet)); + return; + } + } String identifier = persistentGet.getIdentifier(); if (downloadCallbacks.containsKey(identifier)) { - /* ignore, because a download does not care about this. */ + /* TODO */ return; } } @@ -834,16 +928,36 @@ public class HighLevelClient { * @see net.pterodactylus.fcp.FcpListener#receivedPersistentPut(net.pterodactylus.fcp.FcpConnection, * net.pterodactylus.fcp.PersistentPut) */ + @SuppressWarnings("synthetic-access") public void receivedPersistentPut(FcpConnection fcpConnection, PersistentPut persistentPut) { - /* TODO */ + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + synchronized (syncObject) { + if (requestListCallback != null) { + RequestListResult requestListResult = requestListCallback.getIntermediaryResult(); + requestListResult.addRequestResult(new PutRequestResult(persistentPut)); + return; + } + } } /** * @see net.pterodactylus.fcp.FcpListener#receivedPersistentPutDir(net.pterodactylus.fcp.FcpConnection, * net.pterodactylus.fcp.PersistentPutDir) */ + @SuppressWarnings("synthetic-access") public void receivedPersistentPutDir(FcpConnection fcpConnection, PersistentPutDir persistentPutDir) { - /* TODO */ + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + synchronized (syncObject) { + if (requestListCallback != null) { + RequestListResult requestListResult = requestListCallback.getIntermediaryResult(); + requestListResult.addRequestResult(new PutDirRequestResult(persistentPutDir)); + return; + } + } } /** @@ -949,10 +1063,9 @@ public class HighLevelClient { downloadResult.setFatallyFailedBlocks(simpleProgress.getFatallyFailed()); downloadResult.setTotalFinalized(simpleProgress.isFinalizedTotal()); downloadCallback.progressUpdated(); - return; } - /* unknown identifier? */ - logger.warning("unknown identifier for SimpleProgress: " + identifier); + HighLevelProgress highLevelProgress = new HighLevelProgress(identifier, simpleProgress.getTotal(), simpleProgress.getRequired(), simpleProgress.getSucceeded(), simpleProgress.getFailed(), simpleProgress.getFatallyFailed(), simpleProgress.isFinalizedTotal()); + fireProgressReceived(identifier, highLevelProgress); } /**