Learn about the process of setting up the Oracle Audit Vault Server development environment.
manifest.xml files.To develop Audit Collection Plug-ins, you must first set up the development environment. This setup provides a consistent environment for developing and testing the collection plug-ins.
Before you set up a developer environment, you must complete the following tasks:
Obtain and install Oracle Audit Vault and Database Firewall 12.2 You must have this version so that you can test the collection plug-in execution and determine whether it captures the correct audit records from the secured target, and makes them available in the server. Also, doing early end-to-end integration tests helps to eliminate any connectivity problems, and other bugs in your code.
Decide the type of collection plug-in to use.
Related Topics
See Also:
Oracle Audit Vault and Database Firewall Installation Guide for more information on installation of Oracle Audit Vault and Database Firewall.
Parent topic: Setting Up Your Development Environment
To set up your development environment, you must first download the Oracle Audit Vault and Database Firewall SDK, and then set up the operating system environment.
To set up your environment for developing collection plug-ins you must follow these steps to download the SDK, and then configure the operating system folders, environment variables, and paths.
To download the SDK, do the following:
Log in to the Audit Vault Server console as an administrator.
Click the Settings tab, and then click Plug-ins (under the System subsection).
Click Download SDK.
Unzip the SDK into an empty directory.
Related Topics
Parent topic: Setting Up Your Development Environment
Learn about the Oracle Audit Vault collection plug-in directory structure, the development environment, and how to stage plug-in manifest.xml files.
STAGE_DIR_ROOT directory.Parent topic: Setting Up Your Development Environment
To create your own collection plug-ins, review the general directory structure for Oracle Audit Vault collections.
The following figure shows a general directory structure.
Example 2-1 General Directory Structure
STAGE_DIR_ROOT
plugin-manifest.xml
jars
mycoll.jar
myjdbc-lib.jar
config
mycoll.properties
bin
mycoll.exe
patches
p3653288_GENERIC.zip
Explanation of General Directory Structure Components
In the example of a general directory structure, the STAGE_DIR_ROOT directory is the root directory where you stage your collection plug-in files. Place the plugin-manifest.xml directly in this directory. Under the STAGE_DIR_ROOT directory, create the following directories:
jars: Holds all the binaries generated through the Java build process.
Place your collector binaries for a Java-based plug-in in the jars directory. You should package the various collector Java classes into a jar file for easier access on the file system. For collection plug-ins, you do not need to package the Collector.jar in to this directory because it is part of the core agent and is automatically available for all collectors that are managed by an agent.
config: Holds any configuration files that the collection plug-in requires to function. These configuration files can be resource bundles, property files, and so on.
bin: Holds any native non-Java binary executables. For example, if your collector code invokes any native non-Java binaries, place them in the bin directory.
Because the agent is supported on multiple platforms, you should build the non-Java binaries on all platforms that the agent supports. In addition, the collector process locates and loads the appropriate binary based on the execution platform, so use a similar naming convention.
patches: Holds any OPatch patches for secured target-specified event attributes that the collector needs to function. If your collector adds new event attributes that are needed during run-time, then contact Oracle Support. Oracle Support will provide you with a patch that adds these events into the Audit Vault Server repository. This approval process is necessary to avoid collisions with other event attribute names across multiple plug-ins. After you have obtained these patches, place them in the patches directory. Then they will automatically be applied to the server during collection plug-in deployment.
Related Topics
Parent topic: Audit Collection Plug-in Directory Structure
Learn about the structure of a stage directory for a collection plug-in for Oracle Audit Vault and Database Firewall.
For a collection plug-in, place all mapper files in the templates directory, as shown in this example. This placement directs the collection plug-in to load the relevant template file based on the information that the file contains.
Example 2-2 Directory Structure For Collection Plug-In
STAGE_DIR_ROOT
plugin-manifest.xml
templates
mycoll-template.xml
config
mycoll.properties
patches
p3653288_GENERIC.zipRelated Topics
Parent topic: Audit Collection Plug-in Directory Structure
Example 2-3 shows the structure of a stage directory for Java-based Collection plug-ins, which is very similar to Example 2-1.
Example 2-3 Directory Structure for Java-Based Collection Plug-in
STAGE_DIR_ROOT
plugin-manifest.xml
jars
mycoll.jar
myjdbc-lib.jar
config
mycoll.properties
bin
mycoll.exe
patches
p3653288_GENERIC.zipParent topic: Audit Collection Plug-in Directory Structure
You must stage the plugin-manifest.xml file directly under the STAGE_DIR_ROOT directory.
The plugin-manifest.xml file is a core XML file that describes the collection plug-in and defines its attributes. You must stage the plugin-manifest.xml file directly under the STAGE_DIR_ROOT directory, as follows:
On UNIX systems: If your stage directory is /opt/final-plugin-stage/, then stage the plugin-manifest.xml file at /opt/final-plugin-stage/plugin-manifest.xml.
On Microsoft Windows systems: If your stage directory is c:\myplugin\final-stage-dir, then stage the plugin-manifest.xml file at c:\myplugin\final-stage-dir\plugin-manifest.xml.
See Also:
"Description of Plug-in Manifest File" for description and lists of attributes
"Example Code" for a complete sample file
Parent topic: Audit Collection Plug-in Directory Structure