2 * jFCPlib - PersistentPut.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 * A “PersistentPut” message notifies a client about a persistent
22 * {@link ClientPut} request.
24 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
26 public class PersistentPut extends BaseMessage implements Identifiable {
29 * Creates a new “PersistentPut” message that wraps the received message.
31 * @param receivedMessage
32 * The received message
34 public PersistentPut(FcpMessage receivedMessage) {
35 super(receivedMessage);
39 * Returns the client token of the request.
41 * @return The client token of the request
43 public String getClientToken() {
44 return getField("ClientToken");
48 * Returns the data length of the request.
50 * @return The data length of the request, or <code>-1</code> if the length
53 public long getDataLength() {
54 return FcpUtils.safeParseLong(getField("DataLength"));
58 * Returns whether the request is on the global queue.
60 * @return <code>true</code> if the request is on the global queue,
61 * <code>false</code> otherwise
63 public boolean isGlobal() {
64 return Boolean.valueOf(getField("Global"));
68 * Returns the identifier of the request.
70 * @return The identifier of the request
73 public String getIdentifier() {
74 return getField("Identifier");
78 * Returns the maximum number of retries for failed blocks. When
79 * <code>-1</code> is returned each block is tried forever.
81 * @return The maximum number of retries for failed blocks, or
82 * <code>-1</code> for unlimited retries, or <code>-2</code> if the
83 * number of retries could not be parsed
85 public int getMaxRetries() {
86 return FcpUtils.safeParseInt(getField("MaxRetries"));
90 * Returns the content type of the data.
92 * @return The content type
94 public String getMetadataContentType() {
95 return getField("Metadata.ContentType");
99 * Returns the persistence of the request.
101 * @return The persistence of the request
103 public Persistence getPersistence() {
104 return Persistence.valueOf(getField("Persistence"));
108 * Returns the priority of the request.
110 * @return The priority of the request, or {@link Priority#unknown} if the
111 * priority could not be parsed
113 public Priority getPriority() {
114 return Priority.values()[FcpUtils.safeParseInt(getField("PriorityClass"), Priority.unknown.ordinal())];
118 * Returns whether this request has started.
120 * @return <code>true</code> if the request has started, <code>false</code>
123 public boolean isStarted() {
124 return Boolean.valueOf(getField("Started"));
128 * Returns the target filename of the request.
130 * @return The target filename of the request
132 public String getTargetFilename() {
133 return getField("TargetFilename");
137 * Returns the upload source of the request.
139 * @return The upload source of the request
141 public UploadFrom getUploadFrom() {
142 return UploadFrom.valueOf(getField("UploadFrom"));
146 * Returns the target URI of the request.
148 * @return The target URI of the request
150 public String getURI() {
151 return getField("URI");
155 * Returns the verbosity of the request.
157 * @return The verbosity of the request
159 public Verbosity getVerbosity() {
160 return Verbosity.valueOf(getField("Verbosity"));