2 * jSite2 - PersistentPutDir.java -
3 * Copyright © 2008 David Roden
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 package net.pterodactylus.util.fcp;
23 * A “PersistentPutDir” is the response to a {@link ClientPutDiskDir} message.
24 * It is also sent as a possible response to a {@link ListPersistentRequests}
27 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
30 public class PersistentPutDir extends BaseMessage {
33 * Creates a new “PersistentPutDir” message that wraps the received message.
35 * @param receivedMessage
36 * The received message
38 PersistentPutDir(FcpMessage receivedMessage) {
39 super(receivedMessage);
43 * Returns the identifier of the request.
45 * @return The identifier of the request
47 public String getIdentifier() {
48 return getField("Identifier");
52 * Returns the URI of the request.
54 * @return The URI of the request
56 public String getURI() {
57 return getField("URI");
61 * Returns the verbosity of the request.
63 * @return The verbosity of the request
65 public Verbosity getVerbosity() {
66 return Verbosity.valueOf(getField("Verbosity"));
70 * Returns the priority of the request.
72 * @return The priority of the request
74 public Priority getPriority() {
75 return Priority.valueOf(getField("PriorityClass"));
79 * Returns whether the request is on the global queue.
81 * @return <code>true</code> if the request is on the global queue,
82 * <code>false</code> if it is on the client-local queue
84 public boolean isGlobal() {
85 return Boolean.valueOf(getField("Global"));
89 * Returns the maximum number of retries for failed blocks.
91 * @return The maximum number of retries, or <code>-1</code> for endless
92 * retries, or <code>-2</code> if the number could not be parsed
94 public int getMaxRetries() {
95 return FcpUtils.safeParseInt(getField("MaxRetries"), -2);
99 * Returns the number of files in the request.
101 * @return The number of files in the request
103 public int getFileCount() {
105 while (getField("Files." + ++fileCount + ".UploadFrom") != null) { /*
114 * Returns the name of the file at the given index. The index is counted
115 * from <code>0</code>.
118 * The index of the file
119 * @return The name of the file at the given index
121 public String getFileName(int fileIndex) {
122 return getField("Files." + fileIndex + ".Name");
126 * Returns the length of the file at the given index. The index is counted
127 * from <code>0</code>.
130 * The index of the file
131 * @return The length of the file at the given index
133 public long getFileDataLength(int fileIndex) {
134 return FcpUtils.safeParseLong(getField("Files." + fileIndex + ".DataLength"));
138 * Returns the upload source of the file at the given index. The index is
139 * counted from <code>0</code>.
142 * The index of the file
143 * @return The upload source of the file at the given index
145 public UploadFrom getFileUploadFrom(int fileIndex) {
146 return UploadFrom.valueOf(getField("Files." + fileIndex + ".UploadFrom"));
150 * Returns the content type of the file at the given index. The index is
151 * counted from <code>0</code>.
154 * The index of the file
155 * @return The content type of the file at the given index
157 public String getFileMetadataContentType(int fileIndex) {
158 return getField("Files." + fileIndex + ".Metadata.ContentType");
162 * Returns the filename of the file at the given index. This value is only
163 * returned if {@link #getFileUploadFrom(int)} is returning
164 * {@link UploadFrom#disk}. The index is counted from <code>0</code>.
167 * The index of the file
168 * @return The filename of the file at the given index
170 public String getFileFilename(int fileIndex) {
171 return getField("Files." + fileIndex + ".Filename");