/*
- * jFCPlib - FcpClient.java -
- * Copyright © 2009 David Roden
+ * jFCPlib - FcpClient.java - Copyright © 2009 David Roden
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
package net.pterodactylus.fcp.highlevel;
import java.io.IOException;
+import java.io.InputStream;
import java.net.InetAddress;
import java.net.URL;
import java.net.UnknownHostException;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
+import java.util.Map.Entry;
import java.util.concurrent.CountDownLatch;
import net.pterodactylus.fcp.AddPeer;
import net.pterodactylus.fcp.EndListPeerNotes;
import net.pterodactylus.fcp.EndListPeers;
import net.pterodactylus.fcp.EndListPersistentRequests;
+import net.pterodactylus.fcp.FCPPluginMessage;
+import net.pterodactylus.fcp.FCPPluginReply;
import net.pterodactylus.fcp.FcpAdapter;
import net.pterodactylus.fcp.FcpConnection;
import net.pterodactylus.fcp.FcpListener;
import net.pterodactylus.fcp.GenerateSSK;
import net.pterodactylus.fcp.GetFailed;
+import net.pterodactylus.fcp.GetNode;
import net.pterodactylus.fcp.ListPeerNotes;
import net.pterodactylus.fcp.ListPeers;
import net.pterodactylus.fcp.ListPersistentRequests;
import net.pterodactylus.fcp.ModifyPeer;
import net.pterodactylus.fcp.ModifyPeerNote;
+import net.pterodactylus.fcp.NodeData;
import net.pterodactylus.fcp.NodeHello;
import net.pterodactylus.fcp.NodeRef;
import net.pterodactylus.fcp.Peer;
import net.pterodactylus.fcp.SSKKeypair;
import net.pterodactylus.fcp.SimpleProgress;
import net.pterodactylus.fcp.WatchGlobal;
+import net.pterodactylus.util.filter.Filter;
+import net.pterodactylus.util.filter.Filters;
import net.pterodactylus.util.thread.ObjectWrapper;
/**
/** Object used for synchronization. */
private final Object syncObject = new Object();
+ /** Listener management. */
+ private final FcpClientListenerManager fcpClientListenerManager = new FcpClientListenerManager(this);
+
/** The name of this client. */
private final String name;
/** The underlying FCP connection. */
private final FcpConnection fcpConnection;
+ /** Whether the client is currently connected. */
+ private volatile boolean connected;
+
/**
* Creates an FCP client with the given name.
*
public FcpClient(String name, InetAddress host, int port) {
this.name = name;
fcpConnection = new FcpConnection(host, port);
+ fcpConnection.addFcpListener(new FcpAdapter() {
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ @SuppressWarnings("synthetic-access")
+ public void connectionClosed(FcpConnection fcpConnection, Throwable throwable) {
+ connected = false;
+ fcpClientListenerManager.fireFcpClientDisconnected();
+ }
+ });
+ }
+
+ //
+ // LISTENER MANAGEMENT
+ //
+
+ /**
+ * Adds an FCP listener to the underlying connection.
+ *
+ * @param fcpListener
+ * The FCP listener to add
+ */
+ public void addFcpListener(FcpListener fcpListener) {
+ fcpConnection.addFcpListener(fcpListener);
+ }
+
+ /**
+ * Removes an FCP listener from the underlying connection.
+ *
+ * @param fcpListener
+ * The FCP listener to remove
+ */
+ public void removeFcpListener(FcpListener fcpListener) {
+ fcpConnection.removeFcpListener(fcpListener);
+ }
+
+ /**
+ * Adds an FCP client listener to the list of registered listeners.
+ *
+ * @param fcpClientListener
+ * The FCP client listener to add
+ */
+ public void addFcpClientListener(FcpClientListener fcpClientListener) {
+ fcpClientListenerManager.addListener(fcpClientListener);
+ }
+
+ /**
+ * Removes an FCP client listener from the list of registered listeners.
+ *
+ * @param fcpClientListener
+ * The FCP client listener to remove
+ */
+ public void removeFcpClientListener(FcpClientListener fcpClientListener) {
+ fcpClientListenerManager.removeListener(fcpClientListener);
}
//
* if an FCP error occurs
*/
public void connect() throws IOException, FcpException {
+ checkConnected(false);
+ connected = true;
new ExtendedFcpAdapter() {
/**
}
}
+ /**
+ * Returns whether this client is currently connected.
+ *
+ * @return {@code true} if the client is currently connected, {@code false}
+ * otherwise
+ */
+ public boolean isConnected() {
+ return connected;
+ }
+
//
// PEER MANAGEMENT
//
}
/**
+ * Returns all darknet peers.
+ *
+ * @param withMetadata
+ * <code>true</code> to include peer metadata
+ * @param withVolatile
+ * <code>true</code> to include volatile peer data
+ * @return A set containing the node’s darknet peers
+ * @throws IOException
+ * if an I/O error occurs
+ * @throws FcpException
+ * if an FCP error occurs
+ */
+ public Collection<Peer> getDarknetPeers(boolean withMetadata, boolean withVolatile) throws IOException, FcpException {
+ Collection<Peer> allPeers = getPeers(withMetadata, withVolatile);
+ Collection<Peer> darknetPeers = new HashSet<Peer>();
+ for (Peer peer : allPeers) {
+ if (!peer.isOpennet() && !peer.isSeed()) {
+ darknetPeers.add(peer);
+ }
+ }
+ return darknetPeers;
+ }
+
+ /**
+ * Returns all opennet peers.
+ *
+ * @param withMetadata
+ * <code>true</code> to include peer metadata
+ * @param withVolatile
+ * <code>true</code> to include volatile peer data
+ * @return A set containing the node’s opennet peers
+ * @throws IOException
+ * if an I/O error occurs
+ * @throws FcpException
+ * if an FCP error occurs
+ */
+ public Collection<Peer> getOpennetPeers(boolean withMetadata, boolean withVolatile) throws IOException, FcpException {
+ Collection<Peer> allPeers = getPeers(withMetadata, withVolatile);
+ Collection<Peer> opennetPeers = new HashSet<Peer>();
+ for (Peer peer : allPeers) {
+ if (peer.isOpennet() && !peer.isSeed()) {
+ opennetPeers.add(peer);
+ }
+ }
+ return opennetPeers;
+ }
+
+ /**
+ * Returns all seed peers.
+ *
+ * @param withMetadata
+ * <code>true</code> to include peer metadata
+ * @param withVolatile
+ * <code>true</code> to include volatile peer data
+ * @return A set containing the node’s seed peers
+ * @throws IOException
+ * if an I/O error occurs
+ * @throws FcpException
+ * if an FCP error occurs
+ */
+ public Collection<Peer> getSeedPeers(boolean withMetadata, boolean withVolatile) throws IOException, FcpException {
+ Collection<Peer> allPeers = getPeers(withMetadata, withVolatile);
+ Collection<Peer> seedPeers = new HashSet<Peer>();
+ for (Peer peer : allPeers) {
+ if (peer.isSeed()) {
+ seedPeers.add(peer);
+ }
+ }
+ return seedPeers;
+ }
+
+ /**
* Adds the given peer to the node.
*
* @param peer
* if an FCP error occurs
*/
public Collection<Request> getGetRequests(final boolean global) throws IOException, FcpException {
- return getRequests(global);
+ return Filters.filteredCollection(getRequests(global), new Filter<Request>() {
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean filterObject(Request request) {
+ return request instanceof GetRequest;
+ }
+ });
}
+ /**
+ * Returns all currently visible persistent put requests.
+ *
+ * @param global
+ * <code>true</code> to return put requests from the global
+ * queue, <code>false</code> to only show requests from the
+ * client-local queue
+ * @return All put requests
+ * @throws IOException
+ * if an I/O error occurs
+ * @throws FcpException
+ * if an FCP error occurs
+ */
+ public Collection<Request> getPutRequests(final boolean global) throws IOException, FcpException {
+ return Filters.filteredCollection(getRequests(global), new Filter<Request>() {
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean filterObject(Request request) {
+ return request instanceof PutRequest;
+ }
+ });
+ }
+
+ /**
+ * Returns all currently visible persistent requests.
+ *
+ * @param global
+ * <code>true</code> to return requests from the global queue,
+ * <code>false</code> to only show requests from the client-local
+ * queue
+ * @return All requests
+ * @throws IOException
+ * if an I/O error occurs
+ * @throws FcpException
+ * if an FCP error occurs
+ */
public Collection<Request> getRequests(final boolean global) throws IOException, FcpException {
final Map<String, Request> requests = Collections.synchronizedMap(new HashMap<String, Request>());
new ExtendedFcpAdapter() {
return requests.values();
}
+ /**
+ * Sends a message to a plugin and waits for the response.
+ *
+ * @param pluginClass
+ * The name of the plugin class
+ * @param parameters
+ * The parameters for the plugin
+ * @return The responses from the plugin
+ * @throws FcpException
+ * if an FCP error occurs
+ * @throws IOException
+ * if an I/O error occurs
+ */
+ public Map<String, String> sendPluginMessage(String pluginClass, Map<String, String> parameters) throws IOException, FcpException {
+ return sendPluginMessage(pluginClass, parameters, 0, null);
+ }
+
+ /**
+ * Sends a message to a plugin and waits for the response.
+ *
+ * @param pluginClass
+ * The name of the plugin class
+ * @param parameters
+ * The parameters for the plugin
+ * @param dataLength
+ * The length of the optional data stream, or {@code 0} if there
+ * is no optional data stream
+ * @param dataInputStream
+ * The input stream for the payload, or {@code null} if there is
+ * no payload
+ * @return The responses from the plugin
+ * @throws FcpException
+ * if an FCP error occurs
+ * @throws IOException
+ * if an I/O error occurs
+ */
+ public Map<String, String> sendPluginMessage(final String pluginClass, final Map<String, String> parameters, final long dataLength, final InputStream dataInputStream) throws IOException, FcpException {
+ final Map<String, String> pluginReplies = Collections.synchronizedMap(new HashMap<String, String>());
+ new ExtendedFcpAdapter() {
+
+ @SuppressWarnings("synthetic-access")
+ private final String identifier = createIdentifier("FCPPluginMessage");
+
+ @Override
+ @SuppressWarnings("synthetic-access")
+ public void run() throws IOException {
+ FCPPluginMessage fcpPluginMessage = new FCPPluginMessage(pluginClass);
+ for (Entry<String, String> parameter : parameters.entrySet()) {
+ fcpPluginMessage.setParameter(parameter.getKey(), parameter.getValue());
+ }
+ fcpPluginMessage.setIdentifier(identifier);
+ if ((dataLength > 0) && (dataInputStream != null)) {
+ fcpPluginMessage.setDataLength(dataLength);
+ fcpPluginMessage.setPayloadInputStream(dataInputStream);
+ }
+ fcpConnection.sendMessage(fcpPluginMessage);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void receivedFCPPluginReply(FcpConnection fcpConnection, FCPPluginReply fcpPluginReply) {
+ if (!fcpPluginReply.getIdentifier().equals(identifier)) {
+ return;
+ }
+ pluginReplies.putAll(fcpPluginReply.getReplies());
+ completionLatch.countDown();
+ }
+
+ }.execute();
+ return pluginReplies;
+ }
+
+ //
+ // NODE INFORMATION
+ //
+
+ /**
+ * Returns information about the node.
+ *
+ * @param giveOpennetRef
+ * Whether to return the OpenNet reference
+ * @param withPrivate
+ * Whether to return private node data
+ * @param withVolatile
+ * Whether to return volatile node data
+ * @return Node information
+ * @throws FcpException
+ * if an FCP error occurs
+ * @throws IOException
+ * if an I/O error occurs
+ */
+ public NodeData getNodeInformation(final Boolean giveOpennetRef, final Boolean withPrivate, final Boolean withVolatile) throws IOException, FcpException {
+ final ObjectWrapper<NodeData> nodeDataWrapper = new ObjectWrapper<NodeData>();
+ new ExtendedFcpAdapter() {
+
+ @Override
+ @SuppressWarnings("synthetic-access")
+ public void run() throws IOException {
+ GetNode getNodeMessage = new GetNode(giveOpennetRef, withPrivate, withVolatile);
+ fcpConnection.sendMessage(getNodeMessage);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) {
+ nodeDataWrapper.set(nodeData);
+ completionLatch.countDown();
+ }
+ }.execute();
+ return nodeDataWrapper.get();
+ }
+
//
// PRIVATE METHODS
//
}
/**
+ * Checks whether the connection is in the required state.
+ *
+ * @param connected
+ * The required connection state
+ * @throws FcpException
+ * if the connection is not in the required state
+ */
+ private void checkConnected(boolean connected) throws FcpException {
+ if (this.connected != connected) {
+ throw new FcpException("Client is " + (connected ? "not" : "already") + " connected.");
+ }
+ }
+
+ /**
+ * Tells the client that it is now disconnected. This method is called by
+ * {@link ExtendedFcpAdapter} only.
+ */
+ private void setDisconnected() {
+ connected = false;
+ }
+
+ /**
* Implementation of an {@link FcpListener} that can store an
* {@link FcpException} and wait for the arrival of a certain command.
*
*/
@SuppressWarnings("synthetic-access")
public void execute() throws IOException, FcpException {
+ checkConnected(true);
fcpConnection.addFcpListener(this);
try {
run();
/* ignore, we’ll loop. */
}
}
+ } catch (IOException ioe1) {
+ setDisconnected();
+ throw ioe1;
} finally {
fcpConnection.removeFcpListener(this);
}
if (fcpException != null) {
+ setDisconnected();
throw fcpException;
}
}
projects / jFCPlib.git / blobdiff