FredPluginFCP.java

/* This code is part of Freenet. It is distributed under the GNU General
 * Public License, version 2 (or at your option any later version). See
 * http://www.gnu.org/ for further details of the GPL. */
package freenet.pluginmanager;

import freenet.support.SimpleFieldSet;
import freenet.support.api.Bucket;

/**
 * Interface that has to be implemented for plugins that want to be talkable
 * via fcp or direct (plugin to plugin)
 *  
 * see plugins.FCPHello for a simple sample.
 * 
 * @author saces
 * @deprecated Use {@link FredPluginFCPMessageHandler.ServerSideFCPMessageHandler} instead
 */
@Deprecated
public interface FredPluginFCP {
	
	public static final int ACCESS_DIRECT = 0;
	public static final int ACCESS_FCP_RESTRICTED = 1;
	public static final int ACCESS_FCP_FULL = 2;
	
	/**
	 * @param replysender interface to send a reply
	 * @param params parameters passed in, can be null
	 * @param data a bucket of data passed in, can be null
	 * @param access 0: direct call (plugin to plugin), 1: FCP restricted access,  2: FCP full access  
	 * @throws PluginNotFoundException If the plugin has already been removed.
	 */
	void handle(PluginReplySender replysender, SimpleFieldSet params, Bucket data, int accesstype);
	
}