2 * jFCPlib - PluginMessage.java - Copyright © 2008 David Roden
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.
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.
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.
19 package net.pterodactylus.fcp;
21 import java.io.InputStream;
24 * An “CPPluginMessage” sends a message with custom parameters and (optional)
25 * payload to a plugin.
27 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
29 public class FCPPluginMessage extends FcpMessage {
32 * @deprecated Use {@link #FCPPluginMessage(String, String)} instead
35 public FCPPluginMessage(String pluginClass) {
36 super("FCPPluginMessage");
37 setField("PluginName", pluginClass);
40 public FCPPluginMessage(String identifier, String pluginClass) {
42 setField("Identifier", identifier);
46 * @deprecated Use {@link #FCPPluginMessage(String, String)} instead
49 public void setIdentifier(String identifier) {
50 setField("Identifier", identifier);
54 * Sets a custom parameter for the plugin.
57 * The key of the parameter
59 * The value of the parameter
61 public void setParameter(String key, String value) {
62 setField("Param." + key, value);
66 * @deprecated Use {@link #setData(InputStream, long)} instead
69 public void setDataLength(long dataLength) {
70 setField("DataLength", String.valueOf(dataLength));
73 public void setData(InputStream payloadInputStream, long dataLength) {
74 setPayloadInputStream(payloadInputStream);
75 setDataLength(dataLength);