Configuring an Enterprise Service Portal Audit Plug-In
The SRC software provides a sample event listener, DefaultAuditEventListener. You can use the sample listener, customize it, or use the information in the sample to create another audit plug-in. The sample event listener is in the SRC software distribution in the directory /SDX/doc/ent/plugindoc/net/juniper/smgt/ent/plugin. The sample listener sends output to a log file. See the documentation for the plug-in in the SRC software distribution in the folder /SDX/doc/ent/plugindoc or on the Juniper Networks Web site at
http://www.juniper.net/techpubs/software/management/sdx/api-index.html
If you create an audit plug-in, you add the plug-in class to the WAR file for the enterprise service portal.
Table 39 shows the common information that is provided by every enterprise service portal audit plug-in event.
Table 40 describes the events that an audit plug-in listener can listen for and the information reported in those events.
Overview of Configuration for an Enterprise Service Portal Audit Plug-In
You must configure the properties for an enterprise service portal audit plug-in in configuration for an enterprise service portal. If you use the sample or create a plug-in based on the sample, use SDX Configuration Editor to configure the plug-in. If you customize the plug-in to use additional API properties, use an LDAP browser or SDX Admin to customize the plug-in.
Configuring the Sample Enterprise Service Portal Audit Plug-In
Use SDX Configuration Editor to configure properties for an enterprise service portal audit plug-in, also referred to as the Enterprise Service Portal audit plug-in, based on the sample.
Before you configure the properties, define the Java class for the plug-in. You can also configure the Java logging utility provided by JDK 1.4 to record the log messages. For more information about this utility, see
http://java.sun.com/j2se/1.4.1/docs/api/java/util/logging/FileHandler.html
To configure the audit plug-in:
For information about using SDX Configuration Editor, see SRC-PE Getting Started Guide, Chapter 39, Using SDX Configuration Editor.
- Import the SRC system configuration from the directory.
- Open a file for an enterprise service portal:
- ENT-MGR.xml in the EASP folder
- NAT-ADDR.xml in the EASP folder
- File that uses the easp_conf template
The EASP Audit Plug_In pane appears.
![]()
- Use the following descriptions to complete the fields in the Audit Plug-in area.
- Save the file.
- Export the SRC system configuration from the directory.
NOTE: You can also use SDX Admin to modify Enterprise Service Portal audit plug-in properties. See Configuring a Customized Enterprise Service Portal Audit Plug-In.
Plug-in Class
- Fully qualified name of the Java class for the Enterprise Service Portal audit plug-in event listener. If you implement your own plug-in event listener, set this property to the Java class of your listener. This property is mandatory for all Enterprise Service Portal audit plug-ins.
- Value—Text string
- Default—net.juniper.smgt.ent.plugin.DefaultAuditEventListener
- Property name—Plugin.EASPAudit.class
Log Destination
- Path to the log file (relative to the folder where you installed the Enterprise Service Portal audit plug-in) and the pattern of the filename.
- Value—Text string, with the following special characters:
- /—Separator for names in the path
- %t—System's temporary folder
- %h—Current user's home folder
- %g—Generated number for this log file
- %u—Unique number for this log file
- %%—Percent sign
Maximum File Size
- Maximum number of bytes that the event listener can write to a file.
- Value—Number of bytes in the range 0-2147483647
- Default—10000
- Property name—Plugin.EASPAudit.log.file.limit
Log File Count
- How many log files the event listener should use.
- Value—Integer in the range 0-2147483647
- Default—3
- Property name—Plugin.EASPAudit.log.file.count
Log File Append Mode
- Whether or not the event listener should add to or replace the exiting information in the log file.
- Value
- Append—Event listener should add new information to existing information.
- Overwrite—Event listener should replace existing information.
Configuring a Customized Enterprise Service Portal Audit Plug-In
If you have customized the Enterprise Service Portal audit plug-in to use additional properties in the API, you must configure the plug-in with an LDAP browser or SDX Admin. To do so:
- Start the LDAP browser or SDX Admin.
- Access the file I=EASP, ou=StaticConfiguration, ou=Configuration, o=Management, o=umc.
- Find the section that contains the properties with the prefix Plugin.EASPAudit.
- Modify the existing properties in the file.
Each field description in the previous section includes a property name for the existing properties.