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

   1 /*
   2  * jFCPlib - AllData.java - Copyright © 2008 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 2 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, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 package net.pterodactylus.fcp;
  20
  21 import java.io.InputStream;
  22
  23 /**
  24  * The “AllData” message carries the payload of a successful {@link ClientGet}
  25  * request. You will only received this message if the {@link ClientGet} request
  26  * was started with a return type of {@link ReturnType#direct}. If you get this
  27  * message and decide that the data is for you, call
  28  * {@link #getPayloadInputStream()} to get the data. If an AllData message
  29  * passes through all registered {@link FcpListener}s without the payload being
  30  * consumed, the payload is discarded!
  31  *
  32  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  33  */
  34 public class AllData extends BaseMessage implements Identifiable {
  35
  36         /** The payload. */
  37         private InputStream payloadInputStream;
  38
  39         /**
  40          * Creates an “AllData” message that wraps the received message.
  41          *
  42          * @param receivedMessage
  43          *            The received message
  44          * @param payloadInputStream
  45          *            The payload
  46          */
  47         AllData(FcpMessage receivedMessage, InputStream payloadInputStream) {
  48                 super(receivedMessage);
  49                 this.payloadInputStream = payloadInputStream;
  50         }
  51
  52         /**
  53          * Returns the identifier of the request.
  54          *
  55          * @return The identifier of the request
  56          */
  57         public String getIdentifier() {
  58                 return getField("Identifier");
  59         }
  60
  61         /**
  62          * Returns the length of the data.
  63          *
  64          * @return The length of the data, or <code>-1</code> if the length could
  65          *         not be parsed
  66          */
  67         public long getDataLength() {
  68                 return FcpUtils.safeParseLong(getField("DataLength"));
  69         }
  70
  71         /**
  72          * Returns the startup time of the request.
  73          *
  74          * @return The startup time of the request (in milliseconds since Jan 1,
  75          *         1970 UTC), or <code>-1</code> if the time could not be parsed
  76          */
  77         public long getStartupTime() {
  78                 return FcpUtils.safeParseLong(getField("StartupTime"));
  79         }
  80
  81         /**
  82          * Returns the completion time of the request.
  83          *
  84          * @return The completion time of the request (in milliseconds since Jan 1,
  85          *         1970 UTC), or <code>-1</code> if the time could not be parsed
  86          */
  87         public long getCompletionTime() {
  88                 return FcpUtils.safeParseLong(getField("CompletionTime"));
  89         }
  90
  91         /**
  92          * Returns the payload input stream. You <strong>have</strong> consume the
  93          * input stream before returning from the
  94          * {@link FcpListener#receivedAllData(FcpConnection, AllData)} method!
  95          *
  96          * @return The payload
  97          */
  98         public InputStream getPayloadInputStream() {
  99                 return payloadInputStream;
 100         }
 101
 102         /**
 103          * Returns the content type of the found file.
 104          *
 105          * @return The content type
 106          */
 107         public String getContentType() {
 108                 return getField("Metadata.ContentType");
 109         }
 110
 111 }