/**
* A high-level client that allows simple yet full-featured access to a Freenet
* node.
- *
+ *
* @author David ‘Bombe’ Roden <bombe@freenetproject.org>
- * @version $Id$
*/
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>());
/** 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. */
/**
* Creates a new high-level client that connects to a node on
* <code>localhost</code>.
- *
- * @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;
}
//
/**
* Adds the given high-level client listener to list of listeners.
- *
+ *
* @param highLevelClientListener
* The listener to add
*/
/**
* Removes the given high-level client listener from the list of listeners.
- *
+ *
* @param highLevelClientListener
* The listener to remove
*/
* Notifies all listeners that a client has connected.
*/
private void fireClientConnected() {
- for (HighLevelClientListener highLevelClientListener: highLevelClientListeners) {
+ for (HighLevelClientListener highLevelClientListener : highLevelClientListeners) {
highLevelClientListener.clientConnected(this);
}
}
/**
* Notifies all listeners that a client has disconnected.
- *
+ *
* @param throwable
* The exception that caused the disconnect, or <code>null</code>
* if there was no exception
*/
private void fireClientDisconnected(Throwable throwable) {
- for (HighLevelClientListener highLevelClientListener: highLevelClientListeners) {
+ for (HighLevelClientListener highLevelClientListener : highLevelClientListeners) {
highLevelClientListener.clientDisconnected(this, throwable);
}
}
/**
* Adds a high-level progress listener.
- *
+ *
* @param highLevelProgressListener
* The high-level progress listener to add
*/
/**
* Removes a high-level progress listener.
- *
+ *
* @param highLevelProgressListener
* The high-level progress listener to remove
*/
/**
* 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(identifier, highLevelProgress);
+ for (HighLevelProgressListener highLevelProgressListener : highLevelProgressListeners) {
+ highLevelProgressListener.progressReceived(this, identifier, highLevelProgress);
}
}
* 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 <code>true</code> if the node is currently connected,
+ * <code>false</code> 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<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;
+ }
}
/**
/**
* Generates a new SSK keypair.
- *
+ *
* @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));
/**
* Sets whether to watch the global queue.
- *
+ *
* @param enabled
- * <code>true</code> to watch the global queue in addition to
- * the client-local queue, <code>false</code> to only watch the
+ * <code>true</code> to watch the global queue in addition to the
+ * client-local queue, <code>false</code> to only watch the
* 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);
}
/**
* 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
+ * @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));
/**
* 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
* @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));
/**
* 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
* @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));
/**
* Adds the peer whose noderef is stored in the given file.
- *
+ *
* @param nodeRef
* The peer’s noderef
* @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));
* 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
* 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);
* 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
* @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);
/**
* 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
+ * @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) {
//
/**
+ * Checks whether the client is already connected and throws an exception if
+ * it is not.
+ *
+ * @throws NotConnectedException
+ * if the client is not connected
+ */
+ private void checkConnection() throws NotConnectedException {
+ synchronized (this) {
+ if (fcpConnection == null) {
+ throw new NotConnectedException("client is not connected");
+ }
+ }
+ }
+
+ /**
* Generates an identifier for the given function.
- *
+ *
* @param function
* The name of the function
* @return An identifier
/**
* Disconnects the client from the node, handing the given Throwable to
* {@link #fireClientDisconnected(Throwable)}.
- *
+ *
* @param throwable
* The exception that caused the disconnect, or <code>null</code>
* if there was no exception
if (fcpConnection != null) {
fcpConnection.close();
}
- fireClientDisconnected(throwable);
+ fcpConnection = null;
}
/**
* FCP listener for {@link HighLevelClient}.
- *
+ *
* @author David ‘Bombe’ Roden <bombe@freenetproject.org>
- * @version $Id$
*/
private class HighLevelClientFcpListener implements FcpListener {
/**
* 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
}
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();
}
/**
* 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
*/
private String readContent(String readFilename) {
+ if (readFilename == null) {
+ return null;
+ }
FileReader fileReader = null;
BufferedReader bufferedFileReader = null;
try {
/**
* Writes the given content to the given file.
- *
+ *
* @param directDiskAccessResult
* The DDA result
* @param writeFilename
/**
* Cleans up any files that written for the given result.
- *
+ *
* @param directDiskAccessResult
* The direct disk access result
*/
}
cancelIdentifier(null);
disconnect(throwable);
+ fireClientDisconnected(throwable);
}
/**
* @see net.pterodactylus.fcp.FcpListener#receivedDataFound(net.pterodactylus.fcp.FcpConnection,
* net.pterodactylus.fcp.DataFound)
*/
+ @SuppressWarnings("synthetic-access")
public void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound) {
- /* TODO */
+ if (fcpConnection != HighLevelClient.this.fcpConnection) {
+ return;
+ }
+ String identifier = dataFound.getIdentifier();
+ HighLevelProgressCallback<DownloadResult> downloadCallback = downloadCallbacks.get(identifier);
+ if (downloadCallback != null) {
+ DownloadResult downloadResult = downloadCallback.getIntermediaryResult();
+ downloadResult.setFinished(true);
+ downloadResult.setFailed(false);
+ downloadCallback.progressUpdated();
+ downloadCallback.setDone();
+ }
+ HighLevelProgress highLevelProgress = new HighLevelProgress(identifier, true);
+ fireProgressReceived(identifier, highLevelProgress);
}
/**
String identifier = getFailed.getIdentifier();
HighLevelProgressCallback<DownloadResult> downloadCallback = downloadCallbacks.remove(identifier);
if (downloadCallback != null) {
- downloadCallback.getIntermediaryResult().setFailed(true);
+ DownloadResult downloadResult = downloadCallback.getIntermediaryResult();
+ downloadResult.setFailed(true);
+ downloadResult.setFinished(true);
downloadCallback.setDone();
return;
}
* @see net.pterodactylus.fcp.FcpListener#receivedPutFailed(net.pterodactylus.fcp.FcpConnection,
* net.pterodactylus.fcp.PutFailed)
*/
+ @SuppressWarnings("synthetic-access")
public void receivedPutFailed(FcpConnection fcpConnection, PutFailed putFailed) {
- /* TODO */
+ if (fcpConnection != HighLevelClient.this.fcpConnection) {
+ return;
+ }
+ String identifier = putFailed.getIdentifier();
+ HighLevelProgressCallback<DownloadResult> downloadCallback = downloadCallbacks.get(identifier);
+ if (downloadCallback != null) {
+ DownloadResult downloadResult = downloadCallback.getIntermediaryResult();
+ downloadResult.setFailed(true);
+ downloadResult.setFinished(true);
+ downloadCallback.progressUpdated();
+ downloadCallback.setDone();
+ }
+ /* TODO - check inserts */
+ HighLevelProgress highLevelProgress = new HighLevelProgress(identifier, true);
+ fireProgressReceived(identifier, highLevelProgress);
}
/**
* @see net.pterodactylus.fcp.FcpListener#receivedPutFetchable(net.pterodactylus.fcp.FcpConnection,
* net.pterodactylus.fcp.PutFetchable)
*/
+ @SuppressWarnings("synthetic-access")
public void receivedPutFetchable(FcpConnection fcpConnection, PutFetchable putFetchable) {
- /* TODO */
+ if (fcpConnection != HighLevelClient.this.fcpConnection) {
+ return;
+ }
+ String identifier = putFetchable.getIdentifier();
+ /* TODO - check inserts */
+ HighLevelProgress highLevelProgress = new HighLevelProgress(identifier);
+ highLevelProgress.setFetchable(true);
+ fireProgressReceived(identifier, highLevelProgress);
}
/**
* @see net.pterodactylus.fcp.FcpListener#receivedPutSuccessful(net.pterodactylus.fcp.FcpConnection,
* net.pterodactylus.fcp.PutSuccessful)
*/
+ @SuppressWarnings("synthetic-access")
public void receivedPutSuccessful(FcpConnection fcpConnection, PutSuccessful putSuccessful) {
- /* TODO */
+ if (fcpConnection != HighLevelClient.this.fcpConnection) {
+ return;
+ }
+ String identifier = putSuccessful.getIdentifier();
+ HighLevelProgressCallback<DownloadResult> downloadCallback = downloadCallbacks.get(identifier);
+ if (downloadCallback != null) {
+ DownloadResult downloadResult = downloadCallback.getIntermediaryResult();
+ downloadResult.setFinished(true);
+ downloadResult.setFailed(false);
+ downloadCallback.progressUpdated();
+ }
+ /* TODO - check inserts */
+ HighLevelProgress highLevelProgress = new HighLevelProgress(identifier, true);
+ fireProgressReceived(identifier, highLevelProgress);
}
/**
downloadResult.setFatallyFailedBlocks(simpleProgress.getFatallyFailed());
downloadResult.setTotalFinalized(simpleProgress.isFinalizedTotal());
downloadCallback.progressUpdated();
- return;
}
+ /* TODO - check inserts */
HighLevelProgress highLevelProgress = new HighLevelProgress(identifier, simpleProgress.getTotal(), simpleProgress.getRequired(), simpleProgress.getSucceeded(), simpleProgress.getFailed(), simpleProgress.getFatallyFailed(), simpleProgress.isFinalizedTotal());
fireProgressReceived(identifier, highLevelProgress);
}
* @see net.pterodactylus.fcp.FcpListener#receivedURIGenerated(net.pterodactylus.fcp.FcpConnection,
* net.pterodactylus.fcp.URIGenerated)
*/
+ @SuppressWarnings("synthetic-access")
public void receivedURIGenerated(FcpConnection fcpConnection, URIGenerated uriGenerated) {
- /* TODO */
+ if (fcpConnection != HighLevelClient.this.fcpConnection) {
+ return;
+ }
+ String identifier = uriGenerated.getIdentifier();
+ /* TODO - check inserts */
+ HighLevelProgress highLevelProgress = new HighLevelProgress(identifier, uriGenerated.getURI());
+ fireProgressReceived(identifier, highLevelProgress);
}
/**
projects / jFCPlib.git / blobdiff