2 * jSite2 - PersistentPut.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.fcp;
23 * A “PersistentPut” message notifies a client about a persistent
24 * {@link ClientPut} request.
26 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
28 public class PersistentPut extends BaseMessage {
31 * Creates a new “PersistentPut” message that wraps the received message.
33 * @param receivedMessage
34 * The received message
36 PersistentPut(FcpMessage receivedMessage) {
37 super(receivedMessage);
41 * Returns the client token of the request.
43 * @return The client token of the request
45 public String getClientToken() {
46 return getField("ClientToken");
50 * Returns the data length of the request.
52 * @return The data length of the request, or <code>-1</code> if the
53 * length could not be parsed
55 public long getDataLength() {
56 return FcpUtils.safeParseLong(getField("DataLength"));
60 * Returns whether the request is on the global queue.
62 * @return <code>true</code> if the request is on the global queue,
63 * <code>false</code> otherwise
65 public boolean isGlobal() {
66 return Boolean.valueOf(getField("Global"));
70 * Returns the identifier of the request.
72 * @return The identifier of the request
74 public String getIdentifier() {
75 return getField("Identifier");
79 * Returns the maximum number of retries for failed blocks. When
80 * <code>-1</code> is returned each block is tried forever.
82 * @return The maximum number of retries for failed blocks, or
83 * <code>-1</code> for unlimited retries, or <code>-2</code> if
84 * the number of retries could not be parsed
86 public int getMaxRetries() {
87 return FcpUtils.safeParseInt(getField("MaxRetries"));
91 * Returns the content type of the data.
93 * @return The content type
95 public String getMetadataContentType() {
96 return getField("Metadata.ContentType");
100 * Returns the persistence of the request.
102 * @return The persistence of the request
104 public Persistence getPersistence() {
105 return Persistence.valueOf(getField("Persistence"));
109 * Returns the priority of the request.
111 * @return The priority of the request, or {@link Priority#unknown} if the
112 * priority could not be parsed
114 public Priority getPriority() {
115 return Priority.values()[FcpUtils.safeParseInt(getField("PriorityClass"), Priority.unknown.ordinal())];
119 * Returns whether this request has started.
121 * @return <code>true</code> if the request has started,
122 * <code>false</code> otherwise
124 public boolean isStarted() {
125 return Boolean.valueOf(getField("Started"));
129 * Returns the target filename of the request.
131 * @return The target filename of the request
133 public String getTargetFilename() {
134 return getField("TargetFilename");
138 * Returns the upload source of the request.
140 * @return The upload source of the request
142 public UploadFrom getUploadFrom() {
143 return UploadFrom.valueOf(getField("UploadFrom"));
147 * Returns the target URI of the request.
149 * @return The target URI of the request
151 public String getURI() {
152 return getField("URI");
156 * Returns the verbosity of the request.
158 * @return The verbosity of the request
160 public Verbosity getVerbosity() {
161 return Verbosity.valueOf(getField("Verbosity"));