oracle.ifs.core.server

Class S_AuditSpecification

java.lang.Object

oracle.ifs.server.S_LibraryObject

oracle.ifs.server.S_TieLibraryObject

oracle.ifs.server.S_SystemObject

oracle.ifs.server.S_TieSystemObject

oracle.ifs.core.server.S_AuditSpecification

All Implemented Interfaces:

IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

S_TieAuditSpecification

public class S_AuditSpecification
extends S_TieSystemObject

The server-side representation of a AuditSpecification.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.server.S_LibraryObject

S_LibraryObject.MapInfo

Field Summary

Fields inherited from class oracle.ifs.server.S_LibraryObject

CASCADE_OP_COPY_PUBLICOBJECT_TO_CATEGORY, CASCADE_OP_COPY_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_DELETE_FAMILY_TO_VERSIONSERIES, CASCADE_OP_DELETE_PUBLICOBJECT_TO_LEFT_RELATIONSHIP, CASCADE_OP_DELETE_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_DELETE_PUBLICOBJECT_TO_VERSIONDESCRIPTION, CASCADE_OP_DELETE_RELATIONSHIP_TO_LEFT_PUBLICOBJECT, CASCADE_OP_DELETE_RELATIONSHIP_TO_RIGHT_PUBLICOBJECT, CASCADE_OP_DELETE_VERSIONDESCRIPTION_TO_PUBLICOBJECT, CASCADE_OP_DELETE_VERSIONDESCRIPTION_TO_VERSIONSERIES, CASCADE_OP_DELETE_VERSIONSERIES_TO_FAMILY, CASCADE_OP_DELETE_VERSIONSERIES_TO_VERSIONDESCRIPTION, CASCADE_OP_FREE_CATEGORY_TO_PUBLICOBJECT, CASCADE_OP_FREE_CATEGORY_TO_SCHEMAOBJECT, CASCADE_OP_FREE_CATEGORY_TO_SYSTEMOBJECT, CASCADE_OP_FREE_FAMILY_TO_VERSIONSERIES, CASCADE_OP_FREE_PUBLICOBJECT_TO_CATEGORY, CASCADE_OP_FREE_PUBLICOBJECT_TO_LEFT_RELATIONSHIP, CASCADE_OP_FREE_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_FREE_PUBLICOBJECT_TO_VERSIONDESCRIPTION, CASCADE_OP_FREE_RELATIONSHIP_TO_LEFT_PUBLICOBJECT, CASCADE_OP_FREE_RELATIONSHIP_TO_RIGHT_PUBLICOBJECT, CASCADE_OP_FREE_SCHEMAOBJECT_TO_CATEGORY, CASCADE_OP_FREE_SYSTEMOBJECT_TO_CATEGORY, CASCADE_OP_FREE_VERSIONDESCRIPTION_TO_PUBLICOBJECT, CASCADE_OP_FREE_VERSIONDESCRIPTION_TO_VERSIONSERIES, CASCADE_OP_FREE_VERSIONSERIES_TO_FAMILY, CASCADE_OP_FREE_VERSIONSERIES_TO_VERSIONDESCRIPTION, CASCADE_OP_UNDEFINED, CASCADE_OP_UNDELETE_FAMILY_TO_VERSIONSERIES, CASCADE_OP_UNDELETE_PUBLICOBJECT_TO_LEFT_RELATIONSHIP, CASCADE_OP_UNDELETE_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_UNDELETE_PUBLICOBJECT_TO_VERSIONDESCRIPTION, CASCADE_OP_UNDELETE_RELATIONSHIP_TO_LEFT_PUBLICOBJECT, CASCADE_OP_UNDELETE_RELATIONSHIP_TO_RIGHT_PUBLICOBJECT, CASCADE_OP_UNDELETE_VERSIONDESCRIPTION_TO_PUBLICOBJECT, CASCADE_OP_UNDELETE_VERSIONDESCRIPTION_TO_VERSIONSERIES, CASCADE_OP_UNDELETE_VERSIONSERIES_TO_FAMILY, CASCADE_OP_UNDELETE_VERSIONSERIES_TO_VERSIONDESCRIPTION, CASCADE_OP_UPDATE_CATEGORY_TO_PUBLICOBJECT, CASCADE_OP_UPDATE_CATEGORY_TO_SCHEMAOBJECT, CASCADE_OP_UPDATE_CATEGORY_TO_SYSTEMOBJECT, CASCADE_OP_UPDATE_PUBLICOBJECT_TO_CATEGORY, CASCADE_OP_UPDATE_SCHEMAOBJECT_TO_CATEGORY, CASCADE_OP_UPDATE_SYSTEMOBJECT_TO_CATEGORY, DEFAULT_RENDERER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	S_AuditSpecification(S_LibrarySession session, Long classId) Constructs an S_AuditSpecification for the case where the object has not been created in the database yet.
protected	S_AuditSpecification(S_LibrarySession session, S_LibraryObjectData data) Constructs an S_AuditSpecification.

Method Summary

Modifier and Type	Method and Description
Serializable	DYNCreateEventTable(Serializable payload) Creates the audit event table indicated by this instance's TABLENAMESUFFIX attribute, if it does not already exist.
Serializable	DYNPurgeAllEvents(Serializable payload) Purges a batch of AuditEvents from their audit histories indiscriminately.
String	getPropertyTableName() Returns the table name to use for event properties for this AuditSpecification.
String	getTableName() Returns the table name to use for events for this AuditSpecification.
String[]	getTableNames() Returns the table names that are used for events for this AuditSpecification.
String	getTableNameSuffix() Returns the table name suffix, for custom audit event tables.
String	getViewName() Returns the table name to use for events for this AuditSpecification.
protected boolean	isBroadcastCreateEventEnabled() Returns indication as to whether create events should be posted.
boolean	isPrivatePropertyTableUsed() Gets the indication as to whether the Audit History for this AuditSpecification uses a private audit property table.
protected boolean	tableExists(Connection conn, String tableName) Return true if there is a row that meets the specified condition for the specified table.

Methods inherited from class oracle.ifs.server.S_SystemObject

addCategory, cascadeFree, createCategories, deriveDefinition, extendedPostInsert, extendedPostUpdate, extendedPreInsert, extendedPreUpdate, getCategories, getCategories, getCategories, handleCascade, removeCategories, updateCategories, verifyCanCreate, verifyCanFree, verifyCanUpdate

Methods inherited from class oracle.ifs.server.S_LibraryObject

added, applyValueDefault, associatedPostFree, associatedPostInsert, associatedPreInsert, canPurge, cascadeCopy, cascadeUpdate, checkRequiredForInsert, checkSettable, clearArrayTypeAttributeValues, clearMapTypeAttributeValues, clonePublicObjectAttribute, constructIdArray, constructIdArray, copy, copy, copyVectorToLibraryObjectArray, createDefaultPolicyPropertyBundle, createDefaultPropertyBundle, createDefaultPropertyBundle, createInstance, deleteRows, deriveOwnerUniqueName, deriveOwnerUniqueName, deriveUppercasedAttribute, determineClassDomain, determinePolicy, determinePolicy, determineValueDefault, determineValueDomain, dispose, DYNInvalidateState, DYNLockRows, equals, equals, executePolicyOperation, extendedPostFree, extendedPreCopy, extendedPreFree, findPolicyFromPropertyBundleAv, free, free, getAttribute, getAttributeByUpperCaseName, getAuditCertificateName, getAuditDomainContext, getAuditEventFolderContext, getClassData, getClassId, getClassName, getClassObject, getContentStorageManager, getData, getDefinition, getEffectivePolicyActionContexts, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getId, getLibraryConnection, getName, getObjectReferenceAttribute, getPropertyBundle, getPropertyValue, getResourceString, getResourceString, getService, getSession, getSessionInterface, getTraceLogger, handleEvent, hashCode, hasNameAttribute, insertReferenceAttributes, insertRow, insertRows, invalidateState, invokeOperation, invokePolicyMethod, isAuditCertificateSecured, isInstanceOf, isPersistent, issueCascade, isTraced, lockRows, postEvent, postEvent, postFree, postInsert, postUpdate, preFree, preInsert, preUpdate, privilegedUpdate, removed, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, toString, trace, update, updateRows, validateStringArray, verifyCanGetContent, verifyCanSetContent, verifyCanSetPolicy, verifyPersistent, verifyWriteableTransactionInProgress

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Constructor Detail

S_AuditSpecification

protected S_AuditSpecification(S_LibrarySession session,
                               S_LibraryObjectData data)
                        throws IfsException

Constructs an S_AuditSpecification.

Parameters:

session - the session context

data - the data component

Throws:

IfsException - if operation fails

(Unpublished)

S_AuditSpecification

protected S_AuditSpecification(S_LibrarySession session,
                               Long classId)
                        throws IfsException

Constructs an S_AuditSpecification for the case where the object has not been created in the database yet.

Parameters:

session - the session context

classId - the ID of the class

Throws:

IfsException - if operation fails

(Unpublished)

Method Detail

getTableNameSuffix

public String getTableNameSuffix()
                          throws IfsException

Returns the table name suffix, for custom audit event tables.

Returns:

the table name suffix, or null if the default table is used

Throws:

IfsException - if the operation fails.

getTableName

public String getTableName()
                    throws IfsException

Returns the table name to use for events for this AuditSpecification.

If the TABLENAMESUFFIX is null, this returns the default table name.

Returns:

the table name to use

Throws:

IfsException - if the operation fails.

getTableNames

public String[] getTableNames()
                       throws IfsException

Returns the table names that are used for events for this AuditSpecification.

Typically this returns just a length 1 array containing only the result of getTableName, but this can be overridden.

Returns:

the table names in use by this instance

Throws:

IfsException - if the operation fails.

getViewName

public String getViewName()
                   throws IfsException

Returns the table name to use for events for this AuditSpecification.

If the TABLENAMESUFFIX is null, this returns the default table name.

Returns:

the table name to use

Throws:

IfsException - if the operation fails.

isPrivatePropertyTableUsed

public boolean isPrivatePropertyTableUsed()
                                   throws IfsException

Gets the indication as to whether the Audit History for this AuditSpecification uses a private audit property table.

Returns:

true if instance uses a private audit property table; false otherwise

Throws:

IfsException - if operation fails

getPropertyTableName

public String getPropertyTableName()
                            throws IfsException

Returns the table name to use for event properties for this AuditSpecification.

If the TABLENAMESUFFIX is null, this returns the default property table name.

Returns:

the property table name to use

Throws:

IfsException - if the operation fails.

isBroadcastCreateEventEnabled

protected boolean isBroadcastCreateEventEnabled()
                                         throws IfsException

Returns indication as to whether create events should be posted.

Overridden by subclasses that require create events (most do not).

Overrides:

isBroadcastCreateEventEnabled in class S_LibraryObject

Returns:

true if create event should be posted

Throws:

IfsException - if operation fails.

DYNCreateEventTable

public Serializable DYNCreateEventTable(Serializable payload)
                                 throws IfsException

Creates the audit event table indicated by this instance's TABLENAMESUFFIX attribute, if it does not already exist.

Parameters:

payload - ignored

Returns:

always returns null

Throws:

IfsException - if the operation fails

(Unpublished)

tableExists

protected boolean tableExists(Connection conn,
                              String tableName)
                       throws SQLException

Return true if there is a row that meets the specified condition for the specified table. Throws if the table does not exist.

Parameters:

conn - the database connection

tableName - the table name

Throws:

SQLException - if the operation fails

(Unpublished)

DYNPurgeAllEvents

public Serializable DYNPurgeAllEvents(Serializable payload)
                               throws IfsException

Purges a batch of AuditEvents from their audit histories indiscriminately.

This should only be used when the target AuditSpecification has no events that are of interest - all events are candidates for deletion. Typically this is used when all events are to be purged carefully by a background process.

Parameters:

payload - An Integer: the max number of AuditEvents to purge

Returns:

An Integer: the number of AuditEvents deleted

Throws:

IfsException - if the operation fails

(Unpublished)