Installing a Plug-in using Configuration

A plug-in can be installed into a communicator using a configuration property of the following form:

CODE


Ice.Plugin.Name=entry_point [arg ...]

Most plug-ins accept only one specific name, so make sure to use the plug-in’s name for Name.

In Java, entry_point is an optional path to a JAR file containing the plug-in, followed by the name of the plug-in factory class that creates the plug-in.

For example:

CODE

Ice.Plugin.CustomLogger=com.example.clearsky.CustomLoggerPluginFactory logLevel=Debug

The Ice.Plugin.* property reference describes entry_point in greater detail.

After extracting the plug-in's entry point from the property value, any remaining text is parsed using semantics similar to that of command-line arguments. Whitespace separates the arguments, and any arguments that contain whitespace must be enclosed in quotes:

CODE

Ice.Plugin.MyPlugin=entry_point --load "C:\Data Files\config.dat"

Ice passes these arguments to the plug-in during construction.

See Also