|
Extension SDK 9.0.5 | ||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Class Summary | |
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. |
The root package of the public Audit (and Metrics) API. Although Metrics is a distinct feature in the user interface, it uses the same APIs and implementation as Audit and most of what is said here applies to both.
Audit offers several faces:
The purpose of the public Audit API is to allow any IDE addin to provide custom analyzers (rules and metrics), transforms, and (less commonly) document models. This and the following documents describe how Audit works and how it can be extended:
The Audit API is organized into the following five packages:
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. |
oracle.jdeveloper.audit.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. |
oracle.jdeveloper.audit.java |
The java package provides supporting classes for
Java source code analyzers and transforms, and predefined Java source code
transforms. |
oracle.jdeveloper.audit.model |
A less common extension to Audit is a custom source code model for a
specific document type; the model
package provides the base and support classes for implementing such a
model. |
oracle.jdeveloper.audit.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 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. |
|
Extension SDK | ||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
Copyright © 1997, 2004, Oracle. All rights reserved.