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

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