freenet.pluginmanager

Class PluginInfoWrapper

java.lang.Object

freenet.pluginmanager.PluginInfoWrapper

All Implemented Interfaces:

java.lang.Comparable<PluginInfoWrapper>

public class PluginInfoWrapper
extends java.lang.Object
implements java.lang.Comparable<PluginInfoWrapper>

Constructor Summary

Constructors

Constructor and Description
PluginInfoWrapper(Node node, FredPlugin plug, java.lang.String filename, boolean isOfficial)

Method Summary

Modifier and Type	Method and Description
boolean	addPluginToadletSymlink(java.lang.String linkfrom)
int	compareTo(PluginInfoWrapper pi)
boolean	finishShutdownPlugin(PluginManager manager, long maxWaitTime, boolean reloading)
Config	getConfig()
ConfigToadlet	getConfigToadlet()
FredPluginFCPMessageHandler.ServerSideFCPMessageHandler	getFCPServerPlugin() If isFCPServerPlugin() returns true, may be called to obtain the FredPluginFCPMessageHandler.ServerSideFCPMessageHandler of the plugin. TODO: Code quality: Currently, all the other is...() functions are used by PluginManager just to then manually cast the plugin main object to the desired type, i.e.
java.lang.String	getFilename()
java.lang.String	getLocalisedPluginName()
FredPlugin	getPlugin()
java.lang.String	getPluginClassName()
long	getPluginLongVersion()
PluginRespirator	getPluginRespirator()
java.lang.String[]	getPluginToadletSymlinks()
java.lang.String	getPluginVersion()
long	getStarted()
SubConfig	getSubConfig()
java.lang.String	getThreadName()
boolean	isBandwidthIndicator()
boolean	isBaseL10nPlugin()
boolean	isConfigurablePlugin()
boolean	isFCPPlugin() Deprecated. Use isFCPServerPlugin()
boolean	isFCPServerPlugin()
boolean	isIPDetectorPlugin()
boolean	isL10nPlugin()
boolean	isMultiplePlugin()
boolean	isOfficialPlugin()
boolean	isPortForwardPlugin()
boolean	isPproxyPlugin()
boolean	isStopping()
boolean	isThemedPlugin()
boolean	isThreadlessPlugin()
boolean	removePluginToadletSymlink(java.lang.String linkfrom)
void	startShutdownPlugin(PluginManager manager, boolean reloading)
void	stopPlugin(PluginManager manager, long maxWaitTime, boolean reloading) Tell the plugin to quit.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginInfoWrapper

public PluginInfoWrapper(Node node,
                         FredPlugin plug,
                         java.lang.String filename,
                         boolean isOfficial)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getThreadName

public java.lang.String getThreadName()

getStarted

public long getStarted()

getPluginClassName

public java.lang.String getPluginClassName()

getPluginVersion

public java.lang.String getPluginVersion()

getPluginToadletSymlinks

public java.lang.String[] getPluginToadletSymlinks()

addPluginToadletSymlink

public boolean addPluginToadletSymlink(java.lang.String linkfrom)

removePluginToadletSymlink

public boolean removePluginToadletSymlink(java.lang.String linkfrom)

startShutdownPlugin

public void startShutdownPlugin(PluginManager manager,
                                boolean reloading)

finishShutdownPlugin

public boolean finishShutdownPlugin(PluginManager manager,
                                    long maxWaitTime,
                                    boolean reloading)

stopPlugin

public void stopPlugin(PluginManager manager,
                       long maxWaitTime,
                       boolean reloading)

Tell the plugin to quit. Interrupt it if it's a thread-based plugin which might be sleeping. Then call removePlugin() on it on the manager - either now, if it's threadless, or after it terminates, if it's thread based.

Parameters:

manager - The plugin manager object.

maxWaitTime - If a plugin is thread-based, we can wait for it to terminate. Set to -1 if you don't want to wait at all, 0 to wait forever or else a value in milliseconds.

isPproxyPlugin

public boolean isPproxyPlugin()

getFilename

public java.lang.String getFilename()

isBandwidthIndicator

public boolean isBandwidthIndicator()

isThreadlessPlugin

public boolean isThreadlessPlugin()

isIPDetectorPlugin

public boolean isIPDetectorPlugin()

isPortForwardPlugin

public boolean isPortForwardPlugin()

isMultiplePlugin

public boolean isMultiplePlugin()

isFCPPlugin

@Deprecated
public boolean isFCPPlugin()

Deprecated. Use isFCPServerPlugin()

isFCPServerPlugin

public boolean isFCPServerPlugin()

getFCPServerPlugin

public FredPluginFCPMessageHandler.ServerSideFCPMessageHandler getFCPServerPlugin()

If isFCPServerPlugin() returns true, may be called to obtain the FredPluginFCPMessageHandler.ServerSideFCPMessageHandler of the plugin.

TODO: Code quality: Currently, all the other is...() functions are used by PluginManager just to then manually cast the plugin main object to the desired type, i.e. it manually does what the body of this function does. This restricts the API to require the plugin main class to implement all the various interfaces. Instead, please add equivalents of this function for all the other is...(), and use those new functions everywhere in PluginManager. This will a preparation for allowing plugins to implement the various interfaces in DIFFERENT classes than their plugin main class - which will be a good idea for keeping plugin main classes short.

isThemedPlugin

public boolean isThemedPlugin()

isL10nPlugin

public boolean isL10nPlugin()

isBaseL10nPlugin

public boolean isBaseL10nPlugin()

isConfigurablePlugin

public boolean isConfigurablePlugin()

isStopping

public boolean isStopping()

getPluginLongVersion

public long getPluginLongVersion()

getPlugin

public FredPlugin getPlugin()

getPluginRespirator

public PluginRespirator getPluginRespirator()

compareTo

public int compareTo(PluginInfoWrapper pi)

Specified by:

compareTo in interface java.lang.Comparable<PluginInfoWrapper>

getConfig

public Config getConfig()

getSubConfig

public SubConfig getSubConfig()

getConfigToadlet

public ConfigToadlet getConfigToadlet()

isOfficialPlugin

public boolean isOfficialPlugin()

getLocalisedPluginName

public java.lang.String getLocalisedPluginName()