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