Management integration
The management integration API enables external applications to trigger PolicyCenter actions or retrieve PolicyCenter data. For example, a console application can call the API to trigger PolicyCenter metrics to be published to an external location.
Examples of retrieved data include lists of the application’s current users, its running batch processes, and its active database connections. The API can also modify some PolicyCenter configuration parameters. The following types of PolicyCenter data can be retrieved.
- Configuration parameter settings
- Retrieve configuration parameter settings and modify the value of certain parameters. Changed parameter settings take effect on the server immediately, without requiring the server to restart. Modified parameter settings do not persist between application sessions. After the server shuts down, PolicyCenter discards the dynamic changes. When the application server is restarted, the parameters originally specified in the config.xml configuration file are used.
- Batch processes
- Retrieve the list of currently running batch processes.
- Users
- Retrieve the list of current users and user sessions.
- Database connections
- Retrieve lists of the active and idle database connections.
- Notifications
- Retrieve the list of notifications pertaining to users locked out due to excessive login failures.
Communication between an external application and the API can occur by using a standard protocol, such as JMX (Java Management Extensions) or SNMP (Simple Network Management Protocol).
Within PolicyCenter, the management integration API is implemented in the form of a plugin. The plugin initializes the desired communication channel and processes API calls that arrive through the channel. Multiple implementations of the management integration API can be registered in PolicyCenter to communication with multiple external applications. Each API implementation must have a unique name.
PolicyCenter exposes data through both its user interface and the management integration API.
In the PolicyCenter
Server Tools tab, application data is retrieved and
listed by selecting the various Sidebar menu items. The Server Tools
tab is accessible to users who have the soapadmin permission.
The management integration API is defined by the ManagementPlugin interface.
A PolicyCenter plugin class can be defined to implement the
interface and handle API calls made by external applications.