oracle.jdeveloper.audit.analyzer

Class SuppressionScheme

java.lang.Object

oracle.jdeveloper.audit.extension.ExtensionBean

oracle.jdeveloper.audit.analyzer.SuppressionScheme

public class SuppressionScheme
extends ExtensionBean

An Audit suppression scheme. An suppression scheme describes a scheme for suppressing issues issues reported through Audit.

Suppression schemes are defined in extension manifests by suppression-scheme-definition elements of an audit-hook element. The definition specifies id, enabled, and transform properties. The id is an immutable property which uniquely identifies the scheme. Audit profiles allow the user to control the enabled property. The definition of a suppression scheme can additionally specify a scheme-specific subclass of this class which defines additional properties of the scheme which the user will also be allowed to change. These properties should be bound properties, which in practice means that the setters should invoke the appropriate ExtensionBean.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object) method.

The definition defines, implicitly or explicitly, label and description strings for the suppression scheme. See ExtensionBean.label() and ExtensionBean.description(). The object which supplies properties for these strings is the SuppressionScheme instance.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_TRANSFORM_COUNT The maximum number of transforms allowed by an suppression type.

Constructor Summary

Constructors

Constructor and Description
SuppressionScheme() Creates a suppression scheme.

Method Summary

Modifier and Type	Method and Description
Category	category()
protected void	copyInternalState(ExtensionBean copy, java.util.Map<java.lang.String,ExtensionBean> context) Copies internal subclass state as part of creating a copy of this bean.
SuppressionSchemeDefinition	definition() Gets the definition of this bean.
Transform[]	getTransforms() Gets the transforms which create an suppression for an issue in this scheme.
boolean	isEnabled() Gets whether this rule is enabled.
Parameter[]	parameters() Gets the parameters declared by this rule, or an empty array if none.
void	setEnabled(boolean newValue) Sets whether this scheme is enabled.
java.lang.String	toString()

Methods inherited from class oracle.jdeveloper.audit.extension.ExtensionBean

addPropertyChangeListener, addPropertyChangeListener, createCopy, description, equals, extensionId, extensionLine, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, formattedString, formattedString, formattedString, hashCode, id, label, logError, logError, logWarning, name, propertyDescription, propertyLabel, removePropertyChangeListener, removePropertyChangeListener, setters, string

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAX_TRANSFORM_COUNT

public static final int MAX_TRANSFORM_COUNT

The maximum number of transforms allowed by an suppression type.

See Also:

Constant Field Values

Constructor Detail

SuppressionScheme

public SuppressionScheme()

Creates a suppression scheme.

The Audit framework uses this constructor for suppression types declared in an extension manifest, and then injects values for the ExtensionBean.id(), ExtensionBean.extensionId(), and transforms properties.

Method Detail

copyInternalState

protected void copyInternalState(ExtensionBean copy,
                                 java.util.Map<java.lang.String,ExtensionBean> context)
                          throws java.lang.reflect.InvocationTargetException

Description copied from class: ExtensionBean

Copies internal subclass state as part of creating a copy of this bean.

Overrides:

copyInternalState in class ExtensionBean

Parameters:

copy - The partially initialized copy.

context - A map which allows subclasses to preserve object identity when copying a graph of extension beans.

Throws:

java.lang.reflect.InvocationTargetException

See Also:

ExtensionBean.createCopy(java.util.Map<java.lang.String, oracle.jdeveloper.audit.extension.ExtensionBean>)

definition

public SuppressionSchemeDefinition definition()

Gets the definition of this bean.

Overrides:

definition in class ExtensionBean

category

public Category category()

parameters

public Parameter[] parameters()

Gets the parameters declared by this rule, or an empty array if none.

isEnabled

public final boolean isEnabled()

Gets whether this rule is enabled.

setEnabled

public final void setEnabled(boolean newValue)

Sets whether this scheme is enabled.

getTransforms

public final Transform[] getTransforms()

Gets the transforms which create an suppression for an issue in this scheme.

Returns:

An array of Transforms.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object