Methods Called at Startup and in Response to Certain Events
This section identifies the server methods that are called at ActivID CMS startup and the server methods that are called in response to certain events.
Server Methods Called at Startup
When ActivID CMS instantiates a plug-in, it calls the following methods.
-
The init() method: called whenever the plug-in is instantiated. This method receives as a parameter the string defined in the generic_plugin.properties file. This file is used for storing connection parameters for the repositories used by the plug-in (for example, the address and credentials for an IDMS An Identity Management System (IDMS) is a system that manages and protects the identity information of PIV card applicants. The IDMS generally falls within the IDPRS domain.).
-
The getPluginVersion() method: returns a string used internally in the ActivID CMS database and in the logs.
-
The getPluginProvider() method: returns a string used internally in the ActivID CMS database and in the logs.
Server Methods Called in Response to Specific Events
When certain events occur, the ActivID CMS responds by calling the following methods.
-
The setAttributes() method: called every time that the ActivID CMS modifies a user attribute. The ActivID CMS passes as input the list of attribute names, their values, and an array of link parameters that can be used by the plug-in to identify the user and context (for example, userid to match the user in the IDMS An Identity Management System (IDMS) is a system that manages and protects the identity information of PIV card applicants. The IDMS generally falls within the IDPRS domain.).
-
The getAttributes() method: called every time the ActivID CMS displays or uses an attribute. The ActivID CMS inputs the list of attribute names to be retrieved and an array of link parameters that is used by the plug-in to identify the user and context (for example, userid to match the user in the IDMS).
