src/main/java/net/pterodactylus/fcp/GetRequestStatus.java

   1 /*
   2  * jFCPlib - GetRequestStatus.java - Copyright © 2008–2016 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 3 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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.fcp;
  19
  20 /**
  21  * The “GetRequestStatus” message is used request status information about a
  22  * running request. It is also the only way to trigger a download of a
  23  * persisted completed {@link ClientGet} with a return type of
  24  * {@link ReturnType#direct}.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  */
  28 public class GetRequestStatus extends FcpMessage {
  29
  30         /**
  31          * Creates a new “GetRequestStatus” message.
  32          *
  33          * @param identifier
  34          *            The identifier of the request
  35          */
  36         public GetRequestStatus(String identifier) {
  37                 super("GetRequestStatus");
  38                 setField("Identifier", identifier);
  39         }
  40
  41         /**
  42          * Sets whether the request is on the global queue.
  43          *
  44          * @param global
  45          *            <code>true</code> if the request is on the global queue,
  46          *            <code>false</code> if it is on the client-local queue
  47          */
  48         public void setGlobal(boolean global) {
  49                 setField("Global", String.valueOf(global));
  50         }
  51
  52         /**
  53          * Sets whether the omit the transmission of the request data in a
  54          * {@link AllData} message.
  55          *
  56          * @param onlyData
  57          *            <code>true</code> to skip transmission of data,
  58          *            <code>false</code> to download data
  59          */
  60         public void setOnlyData(boolean onlyData) {
  61                 setField("OnlyData", String.valueOf(onlyData));
  62         }
  63
  64 }