freenet.pluginmanager

Class PluginManager

java.lang.Object

freenet.pluginmanager.PluginManager

public class PluginManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginManager.PluginProgress Tracks the progress of loading and starting a plugin.

Field Summary

Fields

Modifier and Type	Field and Description
RequestClient	singleUpdaterRequestClient All plugin updates are on a single request client.

Constructor Summary

Constructors

Constructor and Description
PluginManager(Node node, int lastVersion)

Method Summary

Modifier and Type	Method and Description
void	addToadletSymlinks(PluginInfoWrapper pi) Deprecated. will be removed in version 1473.
void	cancelRunningLoads(java.lang.String filename, PluginManager.PluginProgress exceptFor)
java.lang.String	dumpPlugins()
java.util.List<OfficialPlugins.OfficialPluginDescription>	findAvailablePlugins() Returns a list of the names of all available official plugins.
FredPluginFCP	getFCPPlugin(java.lang.String plugname) Deprecated. The FredPluginFCP API, which this returns, was deprecated to be replaced by FredPluginFCPMessageHandler.ServerSideFCPMessageHandler. Plugin authors should implement the new interface instead of the old, and this codepath to support plugins which implement the old interface should be removed one day. No new code will be needed then: The code to use the new interface already exists in its own codepath - the equivalent function for the new API is {link #getPluginFCPServer(String)}, and it is already being used automatically for plugins which implement it.
PageMaker.THEME	getFProxyTheme() Deprecated. will be removed in version 1473.
OfficialPlugins.OfficialPluginDescription	getOfficialPlugin(java.lang.String name)
java.util.Collection<OfficialPlugins.OfficialPluginDescription>	getOfficialPlugins()
FredPluginFCPMessageHandler.ServerSideFCPMessageHandler	getPluginFCPServer(java.lang.String pluginClassName) Get the FredPluginFCPMessageHandler.ServerSideFCPMessageHandler of the plugin with the given class name.
java.io.File	getPluginFilename(java.lang.String pluginName)
PluginInfoWrapper	getPluginInfo(java.lang.String plugname) Deprecated. This function was deprecated because the "or filename" part of the function specification was NOT documented before it was deprecated. Thus it is possible that legacy callers of the function did wrongly expect or not expect that. When removing this function, please review the callers for correctness with regards to that. You might replace usage of this function with getPluginInfoByClassName(String).
PluginInfoWrapper	getPluginInfoByClassName(java.lang.String pluginClassName)
java.util.Set<PluginInfoWrapper>	getPlugins()
java.util.Set<PluginManager.PluginProgress>	getStartingPlugins() Returns a set of all currently starting plugins.
java.lang.String	handleHTTPGet(java.lang.String plugin, HTTPRequest request)
java.lang.String	handleHTTPPost(java.lang.String plugin, HTTPRequest request)
boolean	isEnabled()
OfficialPlugins.OfficialPluginDescription	isOfficialPlugin(java.lang.String name)
boolean	isPluginLoaded(java.lang.String plugname) look for a Plugin with given classname
boolean	isPluginLoadedOrLoadingOrWantLoad(java.lang.String plugname)
void	killPlugin(FredPlugin plugin, long maxWaitTime)
void	killPlugin(java.lang.String name, long maxWaitTime, boolean reloading)
void	killPluginByClass(java.lang.String name, long maxWaitTime)
void	killPluginByFilename(java.lang.String name, long maxWaitTime, boolean reloading)
boolean	loadOfficialPluginsFromWeb()
void	removeCachedCopy(java.lang.String pluginSpecification) Removes the cached copy of the given plugin from the plugins/ directory.
void	removePlugin(PluginInfoWrapper pi) Remove a plugin from the plugin list.
void	removeToadletSymlinks(PluginInfoWrapper pi) Deprecated. will be removed in version 1473.
void	setFProxyTheme(PageMaker.THEME cssName)
static void	setLanguage(BaseL10n.LANGUAGE lang)
void	start()
PluginInfoWrapper	startPluginAuto(java.lang.String pluginname, boolean store)
PluginInfoWrapper	startPluginFile(java.lang.String filename, boolean store)
PluginInfoWrapper	startPluginFreenet(java.lang.String filename, boolean store)
PluginInfoWrapper	startPluginOfficial(java.lang.String pluginname, boolean store, boolean force, boolean forceHTTPS)
PluginInfoWrapper	startPluginOfficial(java.lang.String pluginname, boolean store, OfficialPlugins.OfficialPluginDescription desc, boolean force, boolean forceHTTPS)
PluginInfoWrapper	startPluginURL(java.lang.String filename, boolean store)
void	stop(long maxWaitTime)
void	unregisterPlugin(PluginInfoWrapper wrapper, FredPlugin plug, boolean reloading)
void	unregisterPluginToadlet(PluginInfoWrapper pi)

Methods inherited from class java.lang.Object

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

Field Detail

singleUpdaterRequestClient

public final RequestClient singleUpdaterRequestClient

All plugin updates are on a single request client.

Constructor Detail

PluginManager

public PluginManager(Node node,
                     int lastVersion)

Method Detail

start

public void start()

stop

public void stop(long maxWaitTime)

getStartingPlugins

public java.util.Set<PluginManager.PluginProgress> getStartingPlugins()

Returns a set of all currently starting plugins.

Returns:

All currently starting plugins

startPluginAuto

public PluginInfoWrapper startPluginAuto(java.lang.String pluginname,
                                         boolean store)

startPluginOfficial

public PluginInfoWrapper startPluginOfficial(java.lang.String pluginname,
                                             boolean store,
                                             boolean force,
                                             boolean forceHTTPS)

startPluginOfficial

public PluginInfoWrapper startPluginOfficial(java.lang.String pluginname,
                                             boolean store,
                                             OfficialPlugins.OfficialPluginDescription desc,
                                             boolean force,
                                             boolean forceHTTPS)

startPluginFile

public PluginInfoWrapper startPluginFile(java.lang.String filename,
                                         boolean store)

startPluginURL

public PluginInfoWrapper startPluginURL(java.lang.String filename,
                                        boolean store)

startPluginFreenet

public PluginInfoWrapper startPluginFreenet(java.lang.String filename,
                                            boolean store)

cancelRunningLoads

public void cancelRunningLoads(java.lang.String filename,
                               PluginManager.PluginProgress exceptFor)

removePlugin

public void removePlugin(PluginInfoWrapper pi)

Remove a plugin from the plugin list.

removeCachedCopy

public void removeCachedCopy(java.lang.String pluginSpecification)

Removes the cached copy of the given plugin from the plugins/ directory.

Parameters:

pluginSpecification - The plugin specification

unregisterPluginToadlet

public void unregisterPluginToadlet(PluginInfoWrapper pi)

addToadletSymlinks

@Deprecated
public void addToadletSymlinks(PluginInfoWrapper pi)

Deprecated. will be removed in version 1473.

removeToadletSymlinks

@Deprecated
public void removeToadletSymlinks(PluginInfoWrapper pi)

Deprecated. will be removed in version 1473.

dumpPlugins

public java.lang.String dumpPlugins()

getPlugins

public java.util.Set<PluginInfoWrapper> getPlugins()

getPluginInfo

@Deprecated
public PluginInfoWrapper getPluginInfo(java.lang.String plugname)

Deprecated. This function was deprecated because the "or filename" part of the function specification was NOT documented before it was deprecated. Thus it is possible that legacy callers of the function did wrongly expect or not expect that. When removing this function, please review the callers for correctness with regards to that.
You might replace usage of this function with getPluginInfoByClassName(String).

Look for PluginInfo for a Plugin with given classname or filename.

Returns:

the PluginInfo or null if not found

getPluginInfoByClassName

public PluginInfoWrapper getPluginInfoByClassName(java.lang.String pluginClassName)

Parameters:

pluginClassName - The name of the main class of the plugin - that is the class which implements FredPlugin.

Returns:

The PluginInfoWrapper for the plugin with the given class name, or null if no matching plugin was found.

getFCPPlugin

@Deprecated
public FredPluginFCP getFCPPlugin(java.lang.String plugname)

Deprecated. The FredPluginFCP API, which this returns, was deprecated to be replaced by FredPluginFCPMessageHandler.ServerSideFCPMessageHandler. Plugin authors should implement the new interface instead of the old, and this codepath to support plugins which implement the old interface should be removed one day. No new code will be needed then: The code to use the new interface already exists in its own codepath - the equivalent function for the new API is {link #getPluginFCPServer(String)}, and it is already being used automatically for plugins which implement it.

look for a FCPPlugin with given classname

Parameters:

plugname -

Returns:

the plugin or null if not found

getPluginFCPServer

public FredPluginFCPMessageHandler.ServerSideFCPMessageHandler getPluginFCPServer(java.lang.String pluginClassName)
                                                                           throws PluginNotFoundException

Get the FredPluginFCPMessageHandler.ServerSideFCPMessageHandler of the plugin with the given class name.

Parameters:

pluginClassName - See getPluginInfoByClassName(String).

Throws:

PluginNotFoundException - If the specified plugin is not loaded or does not provide an FCP server.

isPluginLoaded

public boolean isPluginLoaded(java.lang.String plugname)

look for a Plugin with given classname

Parameters:

plugname -

Returns:

the true if not found

isPluginLoadedOrLoadingOrWantLoad

public boolean isPluginLoadedOrLoadingOrWantLoad(java.lang.String plugname)

Parameters:

plugname - The plugin filename e.g. "Library" for an official plugin.

Returns:

the true if not found

handleHTTPGet

public java.lang.String handleHTTPGet(java.lang.String plugin,
                                      HTTPRequest request)
                               throws PluginHTTPException

Throws:

PluginHTTPException

handleHTTPPost

public java.lang.String handleHTTPPost(java.lang.String plugin,
                                       HTTPRequest request)
                                throws PluginHTTPException

Throws:

PluginHTTPException

killPlugin

public void killPlugin(java.lang.String name,
                       long maxWaitTime,
                       boolean reloading)

killPluginByFilename

public void killPluginByFilename(java.lang.String name,
                                 long maxWaitTime,
                                 boolean reloading)

killPluginByClass

public void killPluginByClass(java.lang.String name,
                              long maxWaitTime)

killPlugin

public void killPlugin(FredPlugin plugin,
                       long maxWaitTime)

getOfficialPlugin

public OfficialPlugins.OfficialPluginDescription getOfficialPlugin(java.lang.String name)

getOfficialPlugins

public java.util.Collection<OfficialPlugins.OfficialPluginDescription> getOfficialPlugins()

findAvailablePlugins

public java.util.List<OfficialPlugins.OfficialPluginDescription> findAvailablePlugins()

Returns a list of the names of all available official plugins. Right now this list is hardcoded but in future we could retrieve this list from emu or from freenet itself.

Returns:

A list of all available plugin names

isOfficialPlugin

public OfficialPlugins.OfficialPluginDescription isOfficialPlugin(java.lang.String name)

getPluginFilename

public java.io.File getPluginFilename(java.lang.String pluginName)

setFProxyTheme

public void setFProxyTheme(PageMaker.THEME cssName)

setLanguage

public static void setLanguage(BaseL10n.LANGUAGE lang)

getFProxyTheme

@Deprecated
public PageMaker.THEME getFProxyTheme()

Deprecated. will be removed in version 1473.

loadOfficialPluginsFromWeb

public boolean loadOfficialPluginsFromWeb()

unregisterPlugin

public void unregisterPlugin(PluginInfoWrapper wrapper,
                             FredPlugin plug,
                             boolean reloading)

isEnabled

public boolean isEnabled()