b3ecab4e743d96fc3a63b4cb4cdf8ee9907a2ccd
[jFCPlib.git] / src / net / pterodactylus / fcp / RemovePersistentRequest.java
1 /*
2  * jSite2 - RemovePersistentRequest.java -
3  * Copyright © 2008 David Roden
4  *
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.
9  *
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.
14  *
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.
18  */
19
20 package net.pterodactylus.fcp;
21
22 /**
23  * The “RemovePersistentRequest” message tells the node to remove a persistent
24  * request, cancelling it first (resulting in a {@link GetFailed} or
25  * {@link PutFailed} message), if necessary.
26  * 
27  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
28  */
29 public class RemovePersistentRequest extends FcpMessage {
30
31         /**
32          * Creates a new “RemovePersistentRequest” message.
33          * 
34          * @param identifier
35          *            The identifier of the request
36          */
37         public RemovePersistentRequest(String identifier) {
38                 super("RemovePersistentRequest");
39                 setField("Identifier", identifier);
40         }
41
42         /**
43          * Sets whether the request is on the global queue.
44          * 
45          * @param global
46          *            <code>true</code> if the request is on the global queue,
47          *            <code>false</code> if it is on the client-local queue
48          */
49         public void setGlobal(boolean global) {
50                 setField("Global", String.valueOf(global));
51         }
52
53 }