Ice

Interface PluginManager

All Known Implementing Classes:

PluginManagerI

public interface PluginManager

Each communicator has a plug-in manager to administer the set of plug-ins.

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	addPlugin(java.lang.String name, Plugin pi) Install a new plug-in.
void	destroy() Called when the communicator is being destroyed.
Plugin	getPlugin(java.lang.String name) Obtain a plug-in by name.
java.lang.String[]	getPlugins() Get a list of plugins installed.
void	initializePlugins() Initialize the configured plug-ins.

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

initializePlugins

void initializePlugins()

Initialize the configured plug-ins. The communicator automatically initializes the plug-ins by default, but an application may need to interact directly with a plug-in prior to initialization. In this case, the application must set Ice.InitPlugins=0 and then invoke initializePlugins() manually. The plug-ins are initialized in the order in which they are loaded. If a plug-in raises an exception during initialization, the communicator invokes destroy on the plug-ins that have already been initialized.

Throws:

InitializationException - Raised if the plug-ins have already been initialized.

getPlugins

java.lang.String[] getPlugins()

Get a list of plugins installed.

Returns:

The names of the plugins installed.

See Also:

getPlugin(java.lang.String)

getPlugin

Plugin getPlugin(java.lang.String name)

Obtain a plug-in by name.

Parameters:

name - The plug-in's name.

Returns:

The plug-in.

Throws:

NotRegisteredException - Raised if no plug-in is found with the given name.

addPlugin

void addPlugin(java.lang.String name,
               Plugin pi)

Install a new plug-in.

Parameters:

name - The plug-in's name.

pi - The plug-in.

Throws:

AlreadyRegisteredException - Raised if a plug-in already exists with the given name.

destroy

void destroy()

Called when the communicator is being destroyed.