com.netegrity.llsdk6.imsapi.plugin
Interface ImsPlugin

public interface ImsPlugin

Method Summary

void	cleanup() This method is called when the plugin instance is being freed.
java.lang.String	getDescription() This method returns a String that describes this plugin instance.
java.lang.String	getName() This method returns a String that can be used as a name for this plugin instance.
java.util.List	getPluginTypeKeys() This method returns a List of Objects that can be used as keys for this plugin.
VersionInfo	getVersion() This method returns a VersionInfo object that shows the version of this plugin instance.
void	init() This method is called once when the plugin instance is first loaded.
boolean	isStarted() This method returns true if the start() method has already been called for this plugin, otherwise it returns false.
void	start() This method is called when the plugin is first returned by the manager to a caller that might actually use it.

Method Detail

init

void init()

This method is called once when the plugin instance is first loaded. It can be used for any setup that does not consume resources, or to check things like ability to connect to remote systems, etc. The method can throw exceptions, which would be the preferred course of action if required connections, etc., can't be verified.

start

void start()

This method is called when the plugin is first returned by the manager to a caller that might actually use it. This is where you would implement setup that actually consumes resources. These persistent resources can be destroyed/freed when the cleanup() method is called.

cleanup

void cleanup()

This method is called when the plugin instance is being freed. Persistent resources that were created by the plugin can be released here.

isStarted

boolean isStarted()

This method returns true if the start() method has already been called for this plugin, otherwise it returns false.

Returns:

getPluginTypeKeys

java.util.List getPluginTypeKeys()

This method returns a List of Objects that can be used as keys for this plugin. Typically these Objects are Strings, but they are not required to be. A given plugin can return any number of different keys, and the plugin will be associated with each key it specifies.

Returns:

getName

java.lang.String getName()

This method returns a String that can be used as a name for this plugin instance. Plugin developers are strongly encouraged to implement this via a property file.

Returns:

getDescription

java.lang.String getDescription()

This method returns a String that describes this plugin instance. Plugin developers are strongly encouraged to implement this via a property file.

Returns:

getVersion

VersionInfo getVersion()

This method returns a VersionInfo object that shows the version of this plugin instance.

Returns: