CA Identity Manager
Java SDK r12.5 SP 8

 

com.netegrity.llsdk6.imsapi.plugin
Interface PluginManager


public interface PluginManager


Method Summary
 java.util.List getPlugins(java.lang.Object key)
          Get all the plugins corresponding to the specified key
 java.util.List getPluginTypeKeys()
          Enumerate all the keys in user
 void initPlugins()
          This method finds all classes in the com.netegrity.ims.plugin.factory package using some Java reflection magic.
 void shutdownPlugins()
          This method shuts down any started plugins.
 

Method Detail

initPlugins

void initPlugins()
This method finds all classes in the com.netegrity.ims.plugin.factory package using some Java reflection magic. Each class is then tested to see if it is an instance of one of the two plugin factory interfaces (ImsGlobalPluginFactory, ImsEnvironmentPluginFactory). If it is, the createPluginInstances() method is invoked, passing in the current environment and returning a List of ImsPlugin instances.

For each returned plugin the init() method is called, and then the getPluginTypeKeys() method is called. For each key returned the plugin is added to a Vector of plugin instances for that key. Each of these Vectors is the value in a Map of Object(key)-to-Vectors(plugin list), the pluginMap. The whole point of the scan/sort process is to populate this Map so that it can be used to quickly provide key-specific plugin lists when getPlugins() is called later. A second Map of Object-to-Booleans, the startedMap, is also created with a False value stored for each type key found. This map will later be used to control invocation of the start() methods on the plugins. Note that start() method is not called on any plugin by initPlugins.


shutdownPlugins

void shutdownPlugins()
This method shuts down any started plugins.


getPlugins

java.util.List getPlugins(java.lang.Object key)
Get all the plugins corresponding to the specified key

Parameters:
key -
Returns:

getPluginTypeKeys

java.util.List getPluginTypeKeys()
Enumerate all the keys in user

Returns:

CA Identity Manager
Java SDK r12.5 SP 8

06/13/2011

© 2011 CA Technologies, Inc. All rights reserved.