rename fcplib to jFCPlib

[jFCPlib.git] / src / net / pterodactylus / fcp / PersistentPut.java

diff --git a/src/net/pterodactylus/fcp/PersistentPut.java b/src/net/pterodactylus/fcp/PersistentPut.java
new file mode 100644 (file)
index 0000000..0ec8a7e
--- /dev/null
+++ b/src/net/pterodactylus/fcp/PersistentPut.java
@@ -0,0 +1,169 @@
+/*
+ * jSite2 - PersistentPut.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.fcp;
+
+/**
+ * A “PersistentPut” message notifies a client about a persistent
+ * {@link ClientPut} request.
+ * 
+ * @author <a href="mailto:dr@ina-germany.de">David Roden</a>
+ * @version $Id$
+ */
+public class PersistentPut extends BaseMessage {
+
+       /**
+        * Creates a new “PersistentPut” message that wraps the received message.
+        * 
+        * @param receivedMessage
+        *            The received message
+        */
+       PersistentPut(FcpMessage receivedMessage) {
+               super(receivedMessage);
+       }
+
+       /**
+        * Returns the client token of the request.
+        * 
+        * @return The client token of the request
+        */
+       public String getClientToken() {
+               return getField("ClientToken");
+       }
+
+       /**
+        * Returns the data length of the request.
+        * 
+        * @return The data length of the request, or <code>-1</code> if the
+        *         length could not be parsed
+        */
+       public long getDataLength() {
+               return FcpUtils.safeParseLong(getField("DataLength"));
+       }
+
+       /**
+        * Returns whether the request is on the global queue.
+        * 
+        * @return <code>true</code> if the request is on the global queue,
+        *         <code>false</code> otherwise
+        */
+       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 maximum number of retries for failed blocks. When
+        * <code>-1</code> is returned each block is tried forever.
+        * 
+        * @return The maximum number of retries for failed blocks, or
+        *         <code>-1</code> for unlimited retries, or <code>-2</code> if
+        *         the number of retries could not be parsed
+        */
+       public int getMaxRetries() {
+               return FcpUtils.safeParseInt(getField("MaxRetries"));
+       }
+
+       /**
+        * Returns the content type of the data.
+        * 
+        * @return The content type
+        */
+       public String getMetadataContentType() {
+               return getField("Metadata.ContentType");
+       }
+
+       /**
+        * Returns the persistence of the request.
+        * 
+        * @return The persistence of the request
+        */
+       public Persistence getPersistence() {
+               return Persistence.valueOf(getField("Persistence"));
+       }
+
+       /**
+        * Returns the priority of the request.
+        * 
+        * @return The priority of the request, or {@link Priority#unknown} if the
+        *         priority could not be parsed
+        */
+       public Priority getPriority() {
+               try {
+                       return Priority.values()[Integer.valueOf(getField("PriorityClass"))];
+               } catch (NumberFormatException nfe1) {
+                       return Priority.unknown;
+               }
+       }
+
+       /**
+        * Returns whether this request has started.
+        * 
+        * @return <code>true</code> if the request has started,
+        *         <code>false</code> otherwise
+        */
+       public boolean isStarted() {
+               return Boolean.valueOf(getField("Started"));
+       }
+
+       /**
+        * Returns the target filename of the request.
+        * 
+        * @return The target filename of the request
+        */
+       public String getTargetFilename() {
+               return getField("TargetFilename");
+       }
+
+       /**
+        * Returns the upload source of the request.
+        * 
+        * @return The upload source of the request
+        */
+       public UploadFrom getUploadFrom() {
+               return UploadFrom.valueOf(getField("UploadFrom"));
+       }
+
+       /**
+        * Returns the target URI of the request.
+        * 
+        * @return The target URI of the request
+        */
+       public String getURI() {
+               return getField("URI");
+       }
+
+       /**
+        * Returns the verbosity of the request.
+        * 
+        * @return The verbosity of the request
+        */
+       public Verbosity getVerbosity() {
+               return Verbosity.valueOf(getField("Verbosity"));
+       }
+
+}