src/net/pterodactylus/fcp/PutFetchable.java

   1 /*
   2  * jSite2 - PutFetchable.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 “PutFetchable” message informs a client that a {@link ClientPut} request
  24  * has progressed far enough that the resulting final URI might already be
  25  * fetchable.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  * @version $Id$
  29  */
  30 public class PutFetchable extends BaseMessage {
  31
  32         /**
  33          * Creates a new “PutFetchable” message that wraps the received message.
  34          *
  35          * @param receivedMessage
  36          *            The received message
  37          */
  38         PutFetchable(FcpMessage receivedMessage) {
  39                 super(receivedMessage);
  40         }
  41
  42         /**
  43          * Returns the identifier of the request.
  44          *
  45          * @return The identifier of the request
  46          */
  47         public String getIdentifier() {
  48                 return getField("Identifier");
  49         }
  50
  51         /**
  52          * Returns whether the request is on the global queue.
  53          *
  54          * @return <code>true</code> if the request is on the global queue,
  55          *         <code>false</code> if it is on the client-local queue
  56          */
  57         public boolean isGlobal() {
  58                 return Boolean.valueOf(getField("Global"));
  59         }
  60
  61         /**
  62          * Returns the URI of the request.
  63          *
  64          * @return The URI of the request
  65          */
  66         public String getURI() {
  67                 return getField("URI");
  68         }
  69
  70 }