Package oracle.jdeveloper.audit

The root package of the public Audit (and Metrics) API.

See: Description

Interface Summary

Interface	Description
AuditPreferences	The Audit preferences.

Class Summary

Class	Description
AbstractAuditAddin	A convenience abstract base class for writing an IDE addin whose purpose is to extend Audit.
AuditManager	The Audit manager.
AuditProvider	A provider of Audit extension components.

Package oracle.jdeveloper.audit Description

The root package of the public Audit (and Metrics) API.

Audit offers several faces:

• an interactive graphical user interface that allows a user to analyze source code, view results, apply transformations, and save reports;
• a command line interface that allows a user to analyze source code, apply�default transformations, and save reports;
• an application programming interface that allows a client to programmatically analyze source code and apply transformations (e.g.,�the Add Javadoc Comments command in the JDeveloper Code Editor context menu ); and
• a framework for analyzing and transforming source code, shared by by the interfaces described above, that provides extension points for custom analyzers, custom transforms, and custom object models (Audit is not limited to Java).

The purpose of the public Audit API is to allow any IDE addin to provide custom analyzers (rules and metrics), transforms, and (less commonly) object models. This and the following documents describe how Audit works and how it can be extended:

• What Happens During an Audit.
• Creating a Custom Analyzer.
• Creating a Custom Transform.
• Creating a Custom Object Model.

The Audit API is organized into the following five subpackages of oracle.jdeveloper.audit:

analyzer	By far the most common extension to Audit is an analyzer that implements custom Audit rules; the analyzer package provides the base and supporting clases for implementing analyzers.
transform	Many analyzers provide custom transforms, to fix rule violations or for some other reason; the transform package provides the base and supporting clases for implementing transforms.
java	The java package provides supporting classes for Java source code analyzers and transforms, and predefined Java source code transforms.
model	A less common extension to Audit is a custom source code model for a specific model type; the model package provides the base and support classes for implementing such a model.
service	The service package provides the API for invoking Audit programmatically, as well as Audit API common classes.

In addition to the five packages, this package directly contains the following three classes:

AuditProvider	An abstract class to be implemented by any IDE addin that wishes to provide extensions to Audit. When Audit is invoked, it uses the AuditProvider instances that have been registered with the AuditManager.
AuditManager	A singleton manager that accepts and stores AuditProvider registrations from IDE addins.
AbstractAuditAddin	A convenience abstract base class for writing an IDE addin whose purpose is to extend Audit. It extends AuditProvider and fully implements the oracle.ide.addin.Addin interface, registering itself as an AuditProvider on IDE initialization. Adding rules to Audit is therefore typically a matter of implementing two classes: an Analyzer subclass and a trivial AbstractAuditAddin subclass that overrides the getAnalyzers method to return the class of the custom analyzer.