Class PluginManagerImpl

java.lang.Object

com.biglybt.pif.PluginManager

com.biglybt.pifimpl.local.PluginManagerImpl

public class PluginManagerImpl
extends PluginManager

Nested Class Summary

Nested classes/interfaces inherited from class PluginManager

PluginManager.StartClientListener

Field Summary

Fields

Modifier and Type	Field	Description
protected static AEMonitor	class_mon
protected static Core	core
private static final boolean	GET_PI_METHODS_OPERATIONAL_FLAG_DEFAULT
protected PluginInitializer	pi
protected static boolean	running
protected static PluginManagerImpl	singleton

Fields inherited from class PluginManager

CA_HIBERNATE, CA_QUIT_VUZE, CA_SHUTDOWN, CA_SLEEP, PR_APP_DIRECTORY, PR_DISABLE_NATIVE_SUPPORT, PR_DOC_DIRECTORY, PR_MULTI_INSTANCE, PR_USER_DIRECTORY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PluginManagerImpl(PluginInitializer _pi)

Method Summary

Modifier and Type	Method	Description
void	executeCloseAction(String action)
void	firePluginEvent(int ev)
PluginInterface	getDefaultPluginInterface()	returns the default plugin interface that can be used to access plugin functionality without an explicit plugin
PluginInstaller	getPluginInstaller()
PluginInterface	getPluginInterfaceByClass(Class c)
PluginInterface	getPluginInterfaceByClass(Class c, boolean operational)	Returns the plugin interface with a given class, or null if not found.
PluginInterface	getPluginInterfaceByClass(String class_name)
PluginInterface	getPluginInterfaceByClass(String class_name, boolean operational)	Returns the plugin interface with a given class name, or null if not found.
PluginInterface	getPluginInterfaceByID(String id)	returns the plugin interface with a given id, or null if not found
PluginInterface	getPluginInterfaceByID(String id, boolean operational)	Returns the plugin interface with a given id, or null if not found.
PluginInterface[]	getPluginInterfaces()	Gets the current set of registered plugins.
PluginInterface[]	getPlugins()	Gets the current set of registered plugins.
PluginInterface[]	getPlugins(boolean expect_partial_result)
List<PluginInterface>	getPluginsWithMethod(String name, Class<?>[] parameters)	*since 5201
protected static PluginManagerImpl	getSingleton(PluginInitializer pi)
boolean	isInitialized()
boolean	isSilentRestartEnabled()
void	refreshPluginList(boolean initialise)
static void	registerPlugin(Plugin plugin, String id, String config_key)
static void	registerPlugin(Class<? extends Plugin> plugin_class)
static void	restartClient()
static void	setStartDetails(Core _core)	When AZ is started directly (i.e.
static void	startClient(String ui, Properties properties, PluginManager.StartClientListener startClientListener)	Starts client.
static void	stopClient()

Methods inherited from class PluginManager

getDefaults, refreshPluginList, registerPlugin

Methods inherited from class Object

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

Field Details

running

protected static boolean running

GET_PI_METHODS_OPERATIONAL_FLAG_DEFAULT

private static final boolean GET_PI_METHODS_OPERATIONAL_FLAG_DEFAULT

See Also:

• Constant Field Values

singleton

protected static PluginManagerImpl singleton

class_mon

protected static AEMonitor class_mon

core

protected static Core core

pi

protected PluginInitializer pi

Constructor Details

PluginManagerImpl

protected PluginManagerImpl(PluginInitializer _pi)

Method Details

getSingleton

protected static PluginManagerImpl getSingleton(PluginInitializer pi)

startClient

public static void startClient(String ui,
 Properties properties,
 PluginManager.StartClientListener startClientListener)
                        throws PluginException

Starts client.

With the exception of null ui, method does not return until client is closed.

Parameters:

ui - "swt", "console", "telnet", etc

properties -

Throws:

PluginException

stopClient

public static void stopClient()
                       throws PluginException

Throws:

PluginException

restartClient

public static void restartClient()
                          throws PluginException

Throws:

PluginException

setStartDetails

public static void setStartDetails(Core _core)

When AZ is started directly (i.e. not via a plugin) this method is called so that the running state is correctly understood

Parameters:

type -

registerPlugin

public static void registerPlugin(Class<? extends Plugin> plugin_class)

registerPlugin

public static void registerPlugin(Plugin plugin,
 String id,
 String config_key)

getPluginInterfaceByID

public PluginInterface getPluginInterfaceByID(String id)

Description copied from class: PluginManager

returns the plugin interface with a given id, or null if not found

Specified by:

getPluginInterfaceByID in class PluginManager

Parameters:

id -

Returns:

getPluginInterfaceByID

public PluginInterface getPluginInterfaceByID(String id,
 boolean operational)

Description copied from class: PluginManager

Returns the plugin interface with a given id, or null if not found.

Specified by:

getPluginInterfaceByID in class PluginManager

Parameters:

id -

operational - If true, only return a PluginInterface if the plugin is operational (i.e. is running).

getPluginInterfaceByClass

public PluginInterface getPluginInterfaceByClass(Class c)

Specified by:

getPluginInterfaceByClass in class PluginManager

getPluginInterfaceByClass

public PluginInterface getPluginInterfaceByClass(Class c,
 boolean operational)

Description copied from class: PluginManager

Returns the plugin interface with a given class, or null if not found.

Specified by:

getPluginInterfaceByClass in class PluginManager

Parameters:

c -

operational - If true, only return a PluginInterface if the plugin is operational (i.e. is running).

getPluginInterfaceByClass

public PluginInterface getPluginInterfaceByClass(String class_name)

Specified by:

getPluginInterfaceByClass in class PluginManager

getPluginInterfaceByClass

public PluginInterface getPluginInterfaceByClass(String class_name,
 boolean operational)

Description copied from class: PluginManager

Returns the plugin interface with a given class name, or null if not found.

Specified by:

getPluginInterfaceByClass in class PluginManager

Parameters:

class_name -

operational - If true, only return a PluginInterface if the plugin is operational (i.e. is running).

getPluginInterfaces

public PluginInterface[] getPluginInterfaces()

Description copied from class: PluginManager

Gets the current set of registered plugins. During initialisation this will probably give partial results as plugin initialisation is non-deterministic.

Specified by:

getPluginInterfaces in class PluginManager

Returns:

getDefaultPluginInterface

public PluginInterface getDefaultPluginInterface()

Description copied from class: PluginManager

returns the default plugin interface that can be used to access plugin functionality without an explicit plugin

Specified by:

getDefaultPluginInterface in class PluginManager

Returns:

null if unavailable

getPlugins

public PluginInterface[] getPlugins()

Description copied from class: PluginManager

Gets the current set of registered plugins. During initialisation this will probably give partial results as plugin initialisation is non-deterministic.

Specified by:

getPlugins in class PluginManager

Returns:

getPlugins

public PluginInterface[] getPlugins(boolean expect_partial_result)

Specified by:

getPlugins in class PluginManager

firePluginEvent

public void firePluginEvent(int ev)

Specified by:

firePluginEvent in class PluginManager

getPluginInstaller

public PluginInstaller getPluginInstaller()

Specified by:

getPluginInstaller in class PluginManager

refreshPluginList

public void refreshPluginList(boolean initialise)

Specified by:

refreshPluginList in class PluginManager

isSilentRestartEnabled

public boolean isSilentRestartEnabled()

Specified by:

isSilentRestartEnabled in class PluginManager

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in class PluginManager

executeCloseAction

public void executeCloseAction(String action)
                        throws PluginException

Specified by:

executeCloseAction in class PluginManager

Parameters:

action - one of the above CA_

Throws:

PluginException

getPluginsWithMethod

public List<PluginInterface> getPluginsWithMethod(String name,
 Class<?>[] parameters)

Description copied from class: PluginManager

*since 5201

Specified by:

getPluginsWithMethod in class PluginManager