src/net/pterodactylus/fcp/ModifyPersistentRequest.java

   1 /*
   2  * jSite2 - ModifyPersistentRequest.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  * A “ModifyPersistentRequest” is used to modify certain properties of a
  24  * persistent request while it is running.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  * @version $Id$
  28  */
  29 public class ModifyPersistentRequest extends FcpMessage {
  30
  31         /**
  32          * Creates a new “ModifyPersistentRequest” that changes the specified
  33          * request.
  34          *
  35          * @param requestIdentifier
  36          *            The identifier of the request
  37          * @param global
  38          *            <code>true</code> if the request is on the global queue,
  39          *            <code>false</code> if it is on the client-local queue
  40          */
  41         public ModifyPersistentRequest(String requestIdentifier, boolean global) {
  42                 super("ModifyPersistentRequest");
  43                 setField("Identifier", requestIdentifier);
  44                 setField("Global", String.valueOf(global));
  45         }
  46
  47         /**
  48          * Sets the new client token of the request.
  49          *
  50          * @param newClientToken
  51          *            The new client token of the request
  52          */
  53         public void setClientToken(String newClientToken) {
  54                 setField("ClientToken", newClientToken);
  55         }
  56
  57         /**
  58          * Sets the new priority of the request.
  59          *
  60          * @param newPriority
  61          *            The new priority of the request
  62          */
  63         public void setPriority(Priority newPriority) {
  64                 setField("PriorityClass", String.valueOf(newPriority));
  65         }
  66
  67 }