2 * jFCPlib - PersistentPutDir.java - Copyright © 2008 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 2 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, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 package net.pterodactylus.fcp;
22 * A “PersistentPutDir” is the response to a {@link ClientPutDiskDir} message.
23 * It is also sent as a possible response to a {@link ListPersistentRequests}
26 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
28 public class PersistentPutDir extends BaseMessage implements Identifiable {
31 * Creates a new “PersistentPutDir” message that wraps the received message.
33 * @param receivedMessage
34 * The received message
36 PersistentPutDir(FcpMessage receivedMessage) {
37 super(receivedMessage);
41 * Returns the identifier of the request.
43 * @return The identifier of the request
46 public String getIdentifier() {
47 return getField("Identifier");
51 * Returns the URI of the request.
53 * @return The URI of the request
55 public String getURI() {
56 return getField("URI");
60 * Returns the verbosity of the request.
62 * @return The verbosity of the request
64 public Verbosity getVerbosity() {
65 return Verbosity.valueOf(getField("Verbosity"));
69 * Returns the priority of the request.
71 * @return The priority of the request
73 public Priority getPriority() {
74 return Priority.values()[FcpUtils.safeParseInt(getField("PriorityClass"), Priority.unknown.ordinal())];
78 * Returns whether the request is on the global queue.
80 * @return <code>true</code> if the request is on the global queue,
81 * <code>false</code> if it is on the client-local queue
83 public boolean isGlobal() {
84 return Boolean.valueOf(getField("Global"));
88 * Returns the maximum number of retries for failed blocks.
90 * @return The maximum number of retries, or <code>-1</code> for endless
91 * retries, or <code>-2</code> if the number could not be parsed
93 public int getMaxRetries() {
94 return FcpUtils.safeParseInt(getField("MaxRetries"), -2);
98 * Returns the number of files in the request.
100 * @return The number of files in the request
102 public int getFileCount() {
104 while (getField("Files." + ++fileCount + ".UploadFrom") != null) {
111 * Returns the name of the file at the given index. The index is counted
112 * from <code>0</code>.
115 * The index of the file
116 * @return The name of the file at the given index
118 public String getFileName(int fileIndex) {
119 return getField("Files." + fileIndex + ".Name");
123 * Returns the length of the file at the given index. The index is counted
124 * from <code>0</code>.
127 * The index of the file
128 * @return The length of the file at the given index
130 public long getFileDataLength(int fileIndex) {
131 return FcpUtils.safeParseLong(getField("Files." + fileIndex + ".DataLength"));
135 * Returns the upload source of the file at the given index. The index is
136 * counted from <code>0</code>.
139 * The index of the file
140 * @return The upload source of the file at the given index
142 public UploadFrom getFileUploadFrom(int fileIndex) {
143 return UploadFrom.valueOf(getField("Files." + fileIndex + ".UploadFrom"));
147 * Returns the content type of the file at the given index. The index is
148 * counted from <code>0</code>.
151 * The index of the file
152 * @return The content type of the file at the given index
154 public String getFileMetadataContentType(int fileIndex) {
155 return getField("Files." + fileIndex + ".Metadata.ContentType");
159 * Returns the filename of the file at the given index. This value is only
160 * returned if {@link #getFileUploadFrom(int)} is returning
161 * {@link UploadFrom#disk}. The index is counted from <code>0</code>.
164 * The index of the file
165 * @return The filename of the file at the given index
167 public String getFileFilename(int fileIndex) {
168 return getField("Files." + fileIndex + ".Filename");