src/main/java/net/pterodactylus/fcp/PersistentGet.java

   1 /*
   2  * jFCPlib - PersistentGet.java - Copyright © 2008–2016 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.fcp;
  19
  20 /**
  21  * The “PersistentGet” message is sent to the client to inform it about a
  22  * persistent download, either in the client-local queue or in the global
  23  * queue.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class PersistentGet extends BaseMessage implements Identifiable {
  28
  29         /**
  30          * Creates a new “PersistentGet” message that wraps the received message.
  31          *
  32          * @param receivedMessage
  33          *            The received message
  34          */
  35         public PersistentGet(FcpMessage receivedMessage) {
  36                 super(receivedMessage);
  37         }
  38
  39         /**
  40          * Returns the identifier of the request.
  41          *
  42          * @return The identifier of the request
  43          */
  44         @Override
  45         public String getIdentifier() {
  46                 return getField("Identifier");
  47         }
  48
  49         /**
  50          * Returns the URI of the request.
  51          *
  52          * @return The URI of the request
  53          */
  54         public String getURI() {
  55                 return getField("URI");
  56         }
  57
  58         /**
  59          * Returns the verbosity of the request.
  60          *
  61          * @return The verbosity of the request
  62          */
  63         public Verbosity getVerbosity() {
  64                 return Verbosity.valueOf(getField("Verbosity"));
  65         }
  66
  67         /**
  68          * Returns the return type of the request.
  69          *
  70          * @return The return type of the request
  71          */
  72         public ReturnType getReturnType() {
  73                 try {
  74                         return ReturnType.valueOf(getField("ReturnType"));
  75                 } catch (IllegalArgumentException iae1) {
  76                         return ReturnType.unknown;
  77                 }
  78         }
  79
  80         /**
  81          * Returns the name of the file the data is downloaded to. This field will
  82          * only be set if {@link #getReturnType()} is {@link ReturnType#disk}.
  83          *
  84          * @return The name of the file the data is downloaded to
  85          */
  86         public String getFilename() {
  87                 return getField("Filename");
  88         }
  89
  90         /**
  91          * Returns the name of the temporary file. This field will only be set if
  92          * {@link #getReturnType()} is {@link ReturnType#disk}.
  93          *
  94          * @return The name of the temporary file
  95          */
  96         public String getTempFilename() {
  97                 return getField("TempFilename");
  98         }
  99
 100         /**
 101          * Returns the client token of the request.
 102          *
 103          * @return The client token of the request
 104          */
 105         public String getClientToken() {
 106                 return getField("ClientToken");
 107         }
 108
 109         /**
 110          * Returns the priority of the request.
 111          *
 112          * @return The priority of the request
 113          */
 114         public Priority getPriority() {
 115                 return Priority.values()[FcpUtils.safeParseInt(getField("PriorityClass"), Priority.unknown.ordinal())];
 116         }
 117
 118         /**
 119          * Returns the persistence of the request.
 120          *
 121          * @return The persistence of the request, or {@link Persistence#unknown}
 122          *         if the persistence could not be parsed
 123          */
 124         public Persistence getPersistence() {
 125                 try {
 126                         return Persistence.valueOf(getField("Persistence"));
 127                 } catch (IllegalArgumentException iae1) {
 128                         return Persistence.unknown;
 129                 }
 130         }
 131
 132         /**
 133          * Returns whether this request is on the global queue or on the
 134          * client-local queue.
 135          *
 136          * @return <code>true</code> if the request is on the global queue,
 137          *         <code>false</code> if the request is on the client-local queue
 138          */
 139         public boolean isGlobal() {
 140                 return Boolean.valueOf(getField("Global"));
 141         }
 142
 143         /**
 144          * Returns the maximum number of retries for a failed block.
 145          *
 146          * @return The maximum number of retries for a failed block,
 147          *         <code>-1</code> for endless retries, <code>-2</code> if the
 148          *         number could not be parsed
 149          */
 150         public int getMaxRetries() {
 151                 return FcpUtils.safeParseInt(getField("MaxRetries"), -2);
 152         }
 153
 154 }