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

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