2 * jFCPlib - PersistentGet.java - Copyright © 2008–2016 David Roden
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.
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.
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/>.
18 package net.pterodactylus.fcp;
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
25 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
27 public class PersistentGet extends BaseMessage implements Identifiable {
30 * Creates a new “PersistentGet” message that wraps the received message.
32 * @param receivedMessage
33 * The received message
35 public PersistentGet(FcpMessage receivedMessage) {
36 super(receivedMessage);
40 * Returns the identifier of the request.
42 * @return The identifier of the request
45 public String getIdentifier() {
46 return getField("Identifier");
50 * Returns the URI of the request.
52 * @return The URI of the request
54 public String getURI() {
55 return getField("URI");
59 * Returns the verbosity of the request.
61 * @return The verbosity of the request
63 public Verbosity getVerbosity() {
64 return Verbosity.valueOf(getField("Verbosity"));
68 * Returns the return type of the request.
70 * @return The return type of the request
72 public ReturnType getReturnType() {
74 return ReturnType.valueOf(getField("ReturnType"));
75 } catch (IllegalArgumentException iae1) {
76 return ReturnType.unknown;
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}.
84 * @return The name of the file the data is downloaded to
86 public String getFilename() {
87 return getField("Filename");
91 * Returns the name of the temporary file. This field will only be set if
92 * {@link #getReturnType()} is {@link ReturnType#disk}.
94 * @return The name of the temporary file
96 public String getTempFilename() {
97 return getField("TempFilename");
101 * Returns the client token of the request.
103 * @return The client token of the request
105 public String getClientToken() {
106 return getField("ClientToken");
110 * Returns the priority of the request.
112 * @return The priority of the request
114 public Priority getPriority() {
115 return Priority.values()[FcpUtils.safeParseInt(getField("PriorityClass"), Priority.unknown.ordinal())];
119 * Returns the persistence of the request.
121 * @return The persistence of the request, or {@link Persistence#unknown}
122 * if the persistence could not be parsed
124 public Persistence getPersistence() {
126 return Persistence.valueOf(getField("Persistence"));
127 } catch (IllegalArgumentException iae1) {
128 return Persistence.unknown;
133 * Returns whether this request is on the global queue or on the
134 * client-local queue.
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
139 public boolean isGlobal() {
140 return Boolean.valueOf(getField("Global"));
144 * Returns the maximum number of retries for a failed block.
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
150 public int getMaxRetries() {
151 return FcpUtils.safeParseInt(getField("MaxRetries"), -2);