oracle.ifs.core.beans

Class AuditHandlerSpecification

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.core.beans.AuditHandlerSpecification

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieAuditHandlerSpecification

public class AuditHandlerSpecification
extends TieSystemObject

Specifies properties for an AuditSpecification's AuditHandler.

Author:

Luis Saenz

See Also:

AuditSpecification

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENTIDENTIFIER_ATTRIBUTE The identifier of the EventHandlerAgent instance responsible for servicing this handler.
static String	AUDITHANDLERCLASSNAME_ATTRIBUTE The fully-qualified class name of the custom AuditHandler implementation to execute.
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	HANDLERTYPE_ATTRIBUTE The type of handler class referenced by this AuditHandlerSpecification.
static int	HANDLERTYPE_CUSTOM An option for the HANDLERTYPE attribute, indicating some other custom handler.
static int	HANDLERTYPE_INTERNAL An option for the HANDLERTYPE attribute, indicating an internal handler reserved for use by Oracle.
static int	HANDLERTYPE_NONE An option for the HANDLERTYPE attribute, indicating no handler present (an impossible value).
static int	HANDLERTYPE_REGULAR An option for the HANDLERTYPE attribute, indicating a regular handler.
static String	NONCOMPETING_ATTRIBUTE The name of the attribute which indicates whether the handler is non-competing, meaning that it can run simultaneously on multiple nodes.
static String	RUNTIMECLASSIFICATION_ATTRIBUTE The name of the attribute which indicates the hierarchical identifier describing the type of this handler for runtime management purposes.
static String	SETTINGS_ATTRIBUTE The name of the Attribute representing the settings used to describe the AuditHandlerSpecification.

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, NAME_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuditHandlerSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs an AuditHandlerSpecification object.

Method Summary

Modifier and Type	Method and Description
void	addSetting(String key, AttributeValue value) Adds a setting (SimpleProperty) for this object.
String	getAgentIdentifier() Deprecated. 9.3.4.0: this attribute is no longer used
String	getAuditHandlerClassName() Returns the fully-qualified class name of the AuditHandler implementation to execute.
String	getBaseTimeOfDayProperty() Returns the base time of day for when the timer notifications should occur.
int	getHandlerType() Returns the type of handler class referenced by this AuditHandlerSpecification, which is a value of: HANDLERTYPE_REGULAR, HANDLERTYPE_INTERNAL, or HANDLERTYPE_CUSTOM.
String	getRuntimeClassification() Returns the hierarchical identifier describing the type of this handler for runtime management purposes.
SimpleProperty[]	getSettings() Gets the settings used to describe this instance.
String	getTimeFormatProperty() Returns the time format to use in computing when the timer notifications should occur.
String	getTimerPeriodProperty() Returns the timeout period to use for timer expiration notifications.
boolean	isNonCompeting() Gets the non-competing status.
boolean	isNotifiedWhenEventsPosted() Returns true if this handler is interested in being called back when registered events are posted.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a SystemObject.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
protected void	preUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the update of a PublicObject.
void	removeHandlerProperty(String key) Removes a property from the PropertyBundle associated with this instance.

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postUpdate, preCreate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, hasNameAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

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

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

HANDLERTYPE_ATTRIBUTE

public static final String HANDLERTYPE_ATTRIBUTE

The type of handler class referenced by this AuditHandlerSpecification. (Integer; enum: {FDK, Internal})

See Also:

Constant Field Values

AUDITHANDLERCLASSNAME_ATTRIBUTE

public static final String AUDITHANDLERCLASSNAME_ATTRIBUTE

The fully-qualified class name of the custom AuditHandler implementation to execute. (String[200])

See Also:

Constant Field Values

AGENTIDENTIFIER_ATTRIBUTE

public static final String AGENTIDENTIFIER_ATTRIBUTE

The identifier of the EventHandlerAgent instance responsible for servicing this handler. (String, 700)

A null value indicates that the default agent instance will service this handler.

See Also:

Constant Field Values

NONCOMPETING_ATTRIBUTE

public static final String NONCOMPETING_ATTRIBUTE

The name of the attribute which indicates whether the handler is non-competing, meaning that it can run simultaneously on multiple nodes.

See Also:

Constant Field Values

RUNTIMECLASSIFICATION_ATTRIBUTE

public static final String RUNTIMECLASSIFICATION_ATTRIBUTE

The name of the attribute which indicates the hierarchical identifier describing the type of this handler for runtime management purposes. (String[700])

See Also:

Constant Field Values

SETTINGS_ATTRIBUTE

public static final String SETTINGS_ATTRIBUTE

The name of the Attribute representing the settings used to describe the AuditHandlerSpecification.

See Also:

Constant Field Values

HANDLERTYPE_NONE

public static final int HANDLERTYPE_NONE

An option for the HANDLERTYPE attribute, indicating no handler present (an impossible value).

See Also:

Constant Field Values

HANDLERTYPE_REGULAR

public static final int HANDLERTYPE_REGULAR

An option for the HANDLERTYPE attribute, indicating a regular handler.

See Also:

Constant Field Values

HANDLERTYPE_INTERNAL

public static final int HANDLERTYPE_INTERNAL

An option for the HANDLERTYPE attribute, indicating an internal handler reserved for use by Oracle.

See Also:

Constant Field Values

HANDLERTYPE_CUSTOM

public static final int HANDLERTYPE_CUSTOM

An option for the HANDLERTYPE attribute, indicating some other custom handler.

See Also:

Constant Field Values

Constructor Detail

AuditHandlerSpecification

protected AuditHandlerSpecification(LibrarySession session,
                                    Long id,
                                    Long classId,
                                    S_LibraryObjectData data)
                             throws IfsException

Constructs an AuditHandlerSpecification object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

getHandlerType

public int getHandlerType()
                   throws IfsException

Returns the type of handler class referenced by this AuditHandlerSpecification, which is a value of: HANDLERTYPE_REGULAR, HANDLERTYPE_INTERNAL, or HANDLERTYPE_CUSTOM.

Returns:

the handler type; defaults to HANDLERTYPE_NONE if not specified

Throws:

IfsException - if the operation fails.

getAuditHandlerClassName

public String getAuditHandlerClassName()
                                throws IfsException

Returns the fully-qualified class name of the AuditHandler implementation to execute.

Returns:

the fully-qualified class name of the AuditHandler.

Throws:

IfsException - if the operation fails

getAgentIdentifier

public String getAgentIdentifier()
                          throws IfsException

Deprecated. 9.3.4.0: this attribute is no longer used

Returns the identifier used previously to identify the EventHandlerAgent instance responsible for servicing this handler.

This attribute is no longer used.

Returns:

the previously used agent identifier

Throws:

IfsException - if the operation fails

getRuntimeClassification

public String getRuntimeClassification()
                                throws IfsException

Returns the hierarchical identifier describing the type of this handler for runtime management purposes.

Returns:

the classification which describes the type of handler

Throws:

IfsException - if the operation fails

isNonCompeting

public boolean isNonCompeting()
                       throws IfsException

Gets the non-competing status.

Returns:

true if the handler is non-competing; false otherwise

Throws:

IfsException - if operation fails

(Published)

getSettings

public SimpleProperty[] getSettings()
                             throws IfsException

Gets the settings used to describe this instance.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

removeHandlerProperty

public void removeHandlerProperty(String key)
                           throws IfsException

Removes a property from the PropertyBundle associated with this instance.

Parameters:

key - the property's key

Throws:

IfsException - if the operation fails

isNotifiedWhenEventsPosted

public boolean isNotifiedWhenEventsPosted()
                                   throws IfsException

Returns true if this handler is interested in being called back when registered events are posted.

Note: If the registered events are known to be frequent, the underlying handler should process them in batches using the handleTimerExpired() callback, and set this property so that this method returns false.

Returns:

true if the handler should be called back when registered events are posted; false otherwise

Throws:

IfsException - if the operation fails.

getTimerPeriodProperty

public String getTimerPeriodProperty()
                              throws IfsException

Returns the timeout period to use for timer expiration notifications.

The value returned is a number with an optional time unit suffix. The supported case-insensitive suffices are:

• D - indicating days
• H - indicating hours
• M - indicating minutes
• S - indicating seconds

If none of these suffices are present in the string, the value must represent an integer, representing the number of millisenconds for the timeout period.

For example, the string "4H" represents a timeout period of four hours, "3d" represents threee days, and "3500" represents 3500 milliseconds.

A null value indicates that the handler will not be notified on a time basis.

Returns:

the timeout period

Throws:

IfsException - if the operation fails.

getBaseTimeOfDayProperty

public String getBaseTimeOfDayProperty()
                                throws IfsException

Returns the base time of day for when the timer notifications should occur.

Is a string representation of the base time of day relative to the timezone default for the default Domain, using a 24-hour clock format. For example, this method returns "18:30:00" if the base time of day is meant to be 6:30 p.m.

If null is returned, a default base time of day should be used (typically "00:00:00").

Returns:

the base time of day, or null if a default should be used

Throws:

IfsException - if the operation fails.

getTimeFormatProperty

public String getTimeFormatProperty()
                             throws IfsException

Returns the time format to use in computing when the timer notifications should occur.

Is a string representation used to construct a SimpleDateFormatter. If a specific handler property is notspecified, the value "HH:mm:ss" will be used as a default.

Returns:

the time format

Throws:

IfsException - if the operation fails.

addSetting

public void addSetting(String key,
                       AttributeValue value)
                throws IfsException

Adds a setting (SimpleProperty) for this object.

Parameters:

key - the setting property's key

value - the setting property's value

Throws:

IfsException - if the operation fails

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Description copied from class: SystemObject

Extensibility point to perform actions after the creation of a SystemObject.

This assumes that a transaction context has already been established.

Overrides:

postCreate in class SystemObject

Parameters:

lodef - object definition that was used to create the object

Throws:

IfsException - if operation fails

preUpdate

protected void preUpdate(LibraryObjectDefinition lodef)
                  throws IfsException

Description copied from class: SystemObject

Extensibility point to perform actions prior to the update of a PublicObject.

Set an option that indicates that Categories are NOT to be created from within S_SystemObject.

Overrides:

preUpdate in class SystemObject

Parameters:

lodef - definition used to define how the target object will be updated

Throws:

IfsException - if operation fails

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being freed in order to all delete or modify objects related to the target object. Subclasses are expected to invoke super.preFree.

Overrides:

preFree in class LibraryObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.