Add interface to mark all FCP messages that have an “Identifier” field.
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / PersistentPut.java
1 /*
2  * jFCPlib - PersistentPut.java - Copyright © 2008 David Roden
3  *
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.
8  *
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.
13  *
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.
17  */
18
19 package net.pterodactylus.fcp;
20
21 /**
22  * A “PersistentPut” message notifies a client about a persistent
23  * {@link ClientPut} request.
24  *
25  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
26  */
27 public class PersistentPut extends BaseMessage {
28
29         /**
30          * Creates a new “PersistentPut” message that wraps the received message.
31          *
32          * @param receivedMessage
33          *            The received message
34          */
35         PersistentPut(FcpMessage receivedMessage) {
36                 super(receivedMessage);
37         }
38
39         /**
40          * Returns the client token of the request.
41          *
42          * @return The client token of the request
43          */
44         public String getClientToken() {
45                 return getField("ClientToken");
46         }
47
48         /**
49          * Returns the data length of the request.
50          *
51          * @return The data length of the request, or <code>-1</code> if the length
52          *         could not be parsed
53          */
54         public long getDataLength() {
55                 return FcpUtils.safeParseLong(getField("DataLength"));
56         }
57
58         /**
59          * Returns whether the request is on the global queue.
60          *
61          * @return <code>true</code> if the request is on the global queue,
62          *         <code>false</code> otherwise
63          */
64         public boolean isGlobal() {
65                 return Boolean.valueOf(getField("Global"));
66         }
67
68         /**
69          * Returns the identifier of the request.
70          *
71          * @return The identifier of the request
72          */
73         public String getIdentifier() {
74                 return getField("Identifier");
75         }
76
77         /**
78          * Returns the maximum number of retries for failed blocks. When
79          * <code>-1</code> is returned each block is tried forever.
80          *
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
84          */
85         public int getMaxRetries() {
86                 return FcpUtils.safeParseInt(getField("MaxRetries"));
87         }
88
89         /**
90          * Returns the content type of the data.
91          *
92          * @return The content type
93          */
94         public String getMetadataContentType() {
95                 return getField("Metadata.ContentType");
96         }
97
98         /**
99          * Returns the persistence of the request.
100          *
101          * @return The persistence of the request
102          */
103         public Persistence getPersistence() {
104                 return Persistence.valueOf(getField("Persistence"));
105         }
106
107         /**
108          * Returns the priority of the request.
109          *
110          * @return The priority of the request, or {@link Priority#unknown} if the
111          *         priority could not be parsed
112          */
113         public Priority getPriority() {
114                 return Priority.values()[FcpUtils.safeParseInt(getField("PriorityClass"), Priority.unknown.ordinal())];
115         }
116
117         /**
118          * Returns whether this request has started.
119          *
120          * @return <code>true</code> if the request has started, <code>false</code>
121          *         otherwise
122          */
123         public boolean isStarted() {
124                 return Boolean.valueOf(getField("Started"));
125         }
126
127         /**
128          * Returns the target filename of the request.
129          *
130          * @return The target filename of the request
131          */
132         public String getTargetFilename() {
133                 return getField("TargetFilename");
134         }
135
136         /**
137          * Returns the upload source of the request.
138          *
139          * @return The upload source of the request
140          */
141         public UploadFrom getUploadFrom() {
142                 return UploadFrom.valueOf(getField("UploadFrom"));
143         }
144
145         /**
146          * Returns the target URI of the request.
147          *
148          * @return The target URI of the request
149          */
150         public String getURI() {
151                 return getField("URI");
152         }
153
154         /**
155          * Returns the verbosity of the request.
156          *
157          * @return The verbosity of the request
158          */
159         public Verbosity getVerbosity() {
160                 return Verbosity.valueOf(getField("Verbosity"));
161         }
162
163 }