src/net/pterodactylus/fcp/PutSuccessful.java

   1 /*
   2  * jSite2 - PutSuccessful.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 “PutSuccessful” message informs a client about a successfully finished
  24  * {@link ClientPut} (or similar) request.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  */
  28 public class PutSuccessful extends BaseMessage {
  29
  30         /**
  31          * Creates a new “PutSuccessful” message that wraps the received message.
  32          *
  33          * @param receivedMessage
  34          *            The received message
  35          */
  36         PutSuccessful(FcpMessage receivedMessage) {
  37                 super(receivedMessage);
  38         }
  39
  40         /**
  41          * Returns the identifier of the request.
  42          *
  43          * @return The identifier of the request
  44          */
  45         public String getIdentifier() {
  46                 return getField("Identifier");
  47         }
  48
  49         /**
  50          * Returns whether the request is on the global queue.
  51          *
  52          * @return <code>true</code> if the request is on the global queue,
  53          *         <code>false</code> if it is on the client-local queue
  54          */
  55         public boolean isGlobal() {
  56                 return Boolean.valueOf(getField("Global"));
  57         }
  58
  59         /**
  60          * Returns the final URI of the {@link ClientPut} request.
  61          *
  62          * @return The final URI of the request
  63          */
  64         public String getURI() {
  65                 return getField("URI");
  66         }
  67
  68         /**
  69          * Returns the time the insert started.
  70          *
  71          * @return The time the insert started (in milliseconds since Jan 1, 1970
  72          *         UTC), or <code>-1</code> if the time could not be parsed
  73          */
  74         public long getStartupTime() {
  75                 return FcpUtils.safeParseLong(getField("StartupTime"));
  76         }
  77
  78         /**
  79          * Returns the time the insert completed.
  80          *
  81          * @return The time the insert completed (in milliseconds since Jan 1, 1970
  82          *         UTC), or <code>-1</code> if the time could not be parsed
  83          */
  84         public long getCompletionTime() {
  85                 return FcpUtils.safeParseLong(getField("CompletionTime"));
  86         }
  87
  88 }