Logging Custom Java Plugin Output in Identity Portal

Products

• CA Identity Manager
• CA Identity Governance
• CA Identity Portal

Issue/Introduction

This article explains how to capture and direct output from custom Java plugins to log files in Identity Portal. When developing custom plugins, System.out.println statements are typically captured by the application server logs (e.g., Wildfly/JBoss logs) rather than specific application-level log files.

Environment

Identity Portal 14.5 & 15

Cause

Custom Java plugins utilize standard Java output streams, which redirect to the server's standard output by default. Implementing formal logging requires integrating with the application's logging framework.

Resolution

1. Develop the Plugin: Reference the Developing a Java Plugin documentation.
2. Implement Logging: Use the standard logger provided by your development environment. Ensure your package declaration in the Java code matches your directory structure.
   • Example Package Setup: package org.ca.idp.plugin_logger;
3. Deploy the Plugin:
   1. Compile your Java class.
   2. Place the compiled .class file into the plugin directory specified in Admin UI > Setup > General Configuration. Ensure the folder structure matches your package name (e.g., {plugin_directory}/org/ca/idp/plugin_logger/).
4. Refresh and Configure:
   1. Navigate to /rest/admin/plugins/refresh in your browser to reload plugin classes.
   2. Access the Plugins element in the Admin UI to enable and configure your plugin.

Additional Information

For further information, you can see the documentation Plugin Samples - 14.5 or Plugin Samples

To speak with a customer representative or a Support Engineer see Contact Support. Scroll to the bottom of the page and click on your respective region.