Class SimpleAPIPlugin

java.lang.Object

com.biglybt.ui.webplugin.WebPlugin

com.biglybt.plugin.simpleapi.SimpleAPIPlugin

All Implemented Interfaces:

Plugin, TrackerWebPageGenerator

public class SimpleAPIPlugin
extends WebPlugin

Field Summary

Fields

Modifier and Type	Field	Description
private StringParameter	api_key
static final String	DEFAULT_ACCESS
static final int	DEFAULT_PORT
private static final Properties	defaults
private static boolean	loaded
private static LoggerChannel	log_channel
private PluginInterface	plugin_interface
static final String	PLUGIN_NAME
private static SimpleAPIPlugin	singleton
private HyperlinkParameter	test_param

Fields inherited from class WebPlugin

CONFIG_ACCESS, CONFIG_ACCESS_DEFAULT, CONFIG_BIND_IP, CONFIG_BIND_IP_DEFAULT, CONFIG_ENABLE, CONFIG_ENABLE_DEFAULT, CONFIG_HOME_PAGE, CONFIG_HOME_PAGE_DEFAULT, CONFIG_I2P_ENABLE, CONFIG_I2P_ENABLE_DEFAULT, CONFIG_MODE, CONFIG_MODE_DEFAULT, CONFIG_MODE_FULL, CONFIG_NO_PW_WHITELIST, CONFIG_NO_PW_WHITELIST_DEFAULT, CONFIG_PAIRING_AUTO_AUTH, CONFIG_PAIRING_AUTO_AUTH_DEFAULT, CONFIG_PAIRING_ENABLE, CONFIG_PAIRING_ENABLE_DEFAULT, CONFIG_PASSWORD, CONFIG_PASSWORD_DEFAULT, CONFIG_PASSWORD_ENABLE, CONFIG_PASSWORD_ENABLE_DEFAULT, CONFIG_PORT, CONFIG_PORT_DEFAULT, CONFIG_PORT_OVERRIDE, CONFIG_PROTOCOL, CONFIG_PROTOCOL_DEFAULT, CONFIG_REVERSE_PROXY, CONFIG_REVERSE_PROXY_DEFAULT, CONFIG_ROOT_DIR, CONFIG_ROOT_DIR_DEFAULT, CONFIG_ROOT_RESOURCE, CONFIG_ROOT_RESOURCE_DEFAULT, CONFIG_TOR_ENABLE, CONFIG_TOR_ENABLE_DEFAULT, CONFIG_UPNP_ENABLE, CONFIG_UPNP_ENABLE_DEFAULT, CONFIG_USER, CONFIG_USER_DEFAULT, NL, PAIRING_MIGRATED, PAIRING_SESSION_KEY, PR_ACCESS, PR_BIND_IP, PR_CONFIG_MODEL, PR_CONFIG_MODEL_PARAMS, PR_DISABLABLE, PR_ENABLE, PR_ENABLE_I2P, PR_ENABLE_KEEP_ALIVE, PR_ENABLE_PAIRING, PR_ENABLE_TOR, PR_ENABLE_UPNP, PR_HIDE_RESOURCE_CONFIG, PR_HOME_PAGE, PR_LOG, PR_NON_BLOCKING, PR_PAIRING_SID, PR_PORT, PR_REVERSE_PROXY, PR_ROOT_DIR, PR_ROOT_RESOURCE, PR_VIEW_MODEL, PROPERTIES_MIGRATED, welcome_files, welcome_pages

Constructor Summary

Constructors

Constructor	Description
SimpleAPIPlugin()

Method Summary

Modifier and Type	Method	Description
private void	addTorrent(TOTorrent torrent)
private String	createAPIKey()
Object	evalScript(Map<String,Object> eval_args)
boolean	generateSupport(TrackerWebPageRequest request, TrackerWebPageResponse response)
private boolean	getBoolean(String value)
private DownloadManager	getDownloadFromHash(Map<String,String> args)
static SimpleAPIPlugin	getSingleton()
void	initialize(PluginInterface pi)	This method is called when the Plugin is loaded by the client
protected void	initStage(int num)
static void	load(PluginInterface plugin_interface)
private String	process(TrackerWebPageResponse response, Map<String,String> args, Map<String, List<String>> multi_args)
protected void	setupServer()
private void	updateTestParam()
protected boolean	verifyReferrer()

Methods inherited from class WebPlugin

generate, getConfigModel, getPort, getProtocol, getServerBindIP, getServerPort, getServerURL, getViewModel, isPluginEnabled, log, log, setupAutoAuth, setupPairing, setupUPnP, setUserAndPassword, unloadPlugin, unsetUserAndPassword, updatePairing, updatePairing, useFile

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Plugin

getInitialProperties

Field Details

PLUGIN_NAME

public static final String PLUGIN_NAME

See Also:

• Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

• Constant Field Values

DEFAULT_ACCESS

public static final String DEFAULT_ACCESS

See Also:

• Constant Field Values

singleton

private static volatile SimpleAPIPlugin singleton

loaded

private static boolean loaded

defaults

private static final Properties defaults

log_channel

private static LoggerChannel log_channel

plugin_interface

private PluginInterface plugin_interface

api_key

private StringParameter api_key

test_param

private HyperlinkParameter test_param

Constructor Details

SimpleAPIPlugin

public SimpleAPIPlugin()

Method Details

load

public static void load(PluginInterface plugin_interface)

getSingleton

public static SimpleAPIPlugin getSingleton()

initialize

public void initialize(PluginInterface pi)
                throws PluginException

Description copied from interface: Plugin

This method is called when the Plugin is loaded by the client

Specified by:

initialize in interface Plugin

Overrides:

initialize in class WebPlugin

Parameters:

pi - the interface that the plugin must use to communicate with the client

Throws:

PluginException

initStage

protected void initStage(int num)

Overrides:

initStage in class WebPlugin

verifyReferrer

protected boolean verifyReferrer()

Overrides:

verifyReferrer in class WebPlugin

setupServer

protected void setupServer()

Overrides:

setupServer in class WebPlugin

updateTestParam

private void updateTestParam()

createAPIKey

private String createAPIKey()

generateSupport

public boolean generateSupport(TrackerWebPageRequest request,
 TrackerWebPageResponse response)
                        throws IOException

Overrides:

generateSupport in class WebPlugin

Throws:

IOException

getDownloadFromHash

private DownloadManager getDownloadFromHash(Map<String,String> args)
                                     throws Exception

Throws:

Exception

process

private String process(TrackerWebPageResponse response,
 Map<String,String> args,
 Map<String, List<String>> multi_args)
                throws Exception

Throws:

Exception

addTorrent

private void addTorrent(TOTorrent torrent)

getBoolean

private boolean getBoolean(String value)
                    throws Exception

Throws:

Exception

evalScript

public Object evalScript(Map<String,Object> eval_args)
                  throws IPCException

Throws:

IPCException