add DataFound

git-svn-id: http://trooper/svn/projects/jSite/trunk@707 c3eda9e8-030b-0410-8277-bc7414b0a119

diff --git a/src/net/pterodactylus/util/fcp/DataFound.java b/src/net/pterodactylus/util/fcp/DataFound.java
new file mode 100644 (file)
index 0000000..f2be2d9
--- /dev/null
+++ b/src/net/pterodactylus/util/fcp/DataFound.java
@@ -0,0 +1,79 @@
+/*
+ * jSite2 - DataFound.java -
+ * Copyright © 2008 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+package net.pterodactylus.util.fcp;
+
+/**
+ * A “DataFound” message signals the client that the data requested by a
+ * {@link ClientGet} operation has been found. This message does not include the
+ * actual data, though.
+ * 
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
+ * @version $Id$
+ */
+public class DataFound extends BaseMessage {
+
+       /**
+        * Creates a new “DataFound” message that wraps the received message.
+        * 
+        * @param receivedMessage
+        *            The received message
+        */
+       public DataFound(FcpMessage receivedMessage) {
+               super(receivedMessage);
+       }
+
+       /**
+        * Returns whether the request is on the global queue.
+        * 
+        * @return <code>true</code> if the request is on the global queue,
+        *         <code>false</code> if the request is on the client-local queue
+        */
+       public boolean isGlobal() {
+               return Boolean.valueOf(getField("Global"));
+       }
+
+       /**
+        * Returns the identifier of the request.
+        * 
+        * @return The identifier of the request
+        */
+       public String getIdentifier() {
+               return getField("Identifier");
+       }
+
+       /**
+        * Returns the content type of the data.
+        * 
+        * @return The content type of the data
+        */
+       public String getMetadataContentType() {
+               return getField("Metadata.ContentType");
+       }
+
+       /**
+        * Returns the length of the data.
+        * 
+        * @return The length of the data
+        */
+       public long getDataLength() {
+               return FcpUtils.safeParseLong(getField("DataLength"));
+       }
+
+}

diff --git a/src/net/pterodactylus/util/fcp/FcpAdapter.java b/src/net/pterodactylus/util/fcp/FcpAdapter.java
index e230574..d520fde 100644 (file)
--- a/src/net/pterodactylus/util/fcp/FcpAdapter.java
+++ b/src/net/pterodactylus/util/fcp/FcpAdapter.java
@@ -128,6 +128,13 @@ public class FcpAdapter implements FcpListener {
        }
 
        /**
+        * @see FcpListener#receivedDataFound(FcpConnection, DataFound)
+        */
+       public void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound) {
+               /* empty. */
+       }
+
+       /**
         * @see net.pterodactylus.util.fcp.FcpListener#receivedAllData(net.pterodactylus.util.fcp.FcpConnection,
         *      net.pterodactylus.util.fcp.AllData)
         */

diff --git a/src/net/pterodactylus/util/fcp/FcpConnection.java b/src/net/pterodactylus/util/fcp/FcpConnection.java
index f5629ca..d5f05ee 100644 (file)
--- a/src/net/pterodactylus/util/fcp/FcpConnection.java
+++ b/src/net/pterodactylus/util/fcp/FcpConnection.java
@@ -330,6 +330,18 @@ public class FcpConnection {
        }
 
        /**
+        * Notifies all listeners that a “DataFound” message was received.
+        * 
+        * @param dataFound
+        *            The “DataFound” message
+        */
+       private void fireReceivedDataFound(DataFound dataFound) {
+               for (FcpListener fcpListener: fcpListeners) {
+                       fcpListener.receivedDataFound(this, dataFound);
+               }
+       }
+
+       /**
         * Notifies all listeners that an “AllData” message was received.
         * 
         * @param allData
@@ -482,6 +494,8 @@ public class FcpConnection {
                        fireReceivedStartedCompression(new StartedCompression(fcpMessage));
                } else if ("FinishedCompression".equals(messageName)) {
                        fireReceivedFinishedCompression(new FinishedCompression(fcpMessage));
+               } else if ("DataFound".equals(messageName)) {
+                       fireReceivedDataFound(new DataFound(fcpMessage));
                } else if ("AllData".equals(messageName)) {
                        long dataLength;
                        try {

diff --git a/src/net/pterodactylus/util/fcp/FcpListener.java b/src/net/pterodactylus/util/fcp/FcpListener.java
index 1792939..c32eb90 100644 (file)
--- a/src/net/pterodactylus/util/fcp/FcpListener.java
+++ b/src/net/pterodactylus/util/fcp/FcpListener.java
@@ -171,6 +171,16 @@ public interface FcpListener extends EventListener {
        public void receivedURIGenerated(FcpConnection fcpConnection, URIGenerated uriGenerated);
 
        /**
+        * Notifies a listener that a “DataFound” was received.
+        * 
+        * @param fcpConnection
+        *            The connection that received the message
+        * @param dataFound
+        *            The “DataFound” message
+        */
+       public void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound);
+
+       /**
         * Notifies a listener that an “AllData” was received.
         * 
         * @param fcpConnection