src/net/pterodactylus/fcp/FCPPluginMessage.java

   1 /*
   2  * jSite2 - PluginMessage.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  * An “CPPluginMessage” sends a message with custom parameters and (optional)
  24  * payload to a plugin.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  */
  28 public class FCPPluginMessage extends FcpMessage {
  29
  30         /**
  31          * Creates a new “FCPPluginMessage” message for the given plugin.
  32          *
  33          * @param pluginClass
  34          *            The name of the plugin class
  35          */
  36         public FCPPluginMessage(String pluginClass) {
  37                 super("FCPPluginMessage");
  38                 setField("PluginName", pluginClass);
  39         }
  40
  41         /**
  42          * Sets the identifier of the request. Though this is still optional you are
  43          * encouraged to include it because the plugin might reply in random order
  44          * to requests.
  45          *
  46          * @param identifier
  47          *            The identifier of the request
  48          */
  49         public void setIdentifier(String identifier) {
  50                 setField("Identifier", identifier);
  51         }
  52
  53         /**
  54          * Sets a custom parameter for the plugin.
  55          *
  56          * @param key
  57          *            The key of the parameter
  58          * @param value
  59          *            The value of the parameter
  60          */
  61         public void setParameter(String key, String value) {
  62                 setField("Param." + key, value);
  63         }
  64
  65         /**
  66          * Sets the length of data of the optional payload. If you call this method
  67          * you also have to call {@link #setPayloadInputStream(java.io.InputStream)}
  68          * !
  69          *
  70          * @param dataLength
  71          *            The length of data in the payload input stream
  72          */
  73         public void setDataLength(long dataLength) {
  74                 setField("DataLength", String.valueOf(dataLength));
  75         }
  76
  77 }