Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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:
  IfsEventHandler, LibraryObjectInterface, SystemObjectInterface, Traceable

Direct Known Subclasses:
  TieAuditHandlerSpecification

    public class AuditHandlerSpecification

extends TieSystemObject

Specifies properties for an AuditSpecification's AuditHandler.

See Also:
  `AuditSpecification`
(Published)

Field Summary
`static java.lang.String` | `AGENTIDENTIFIER_ATTRIBUTE` The identifier of the EventHandlerAgent instance responsible for servicing this handler.
`static java.lang.String` | `AUDITHANDLERCLASSNAME_ATTRIBUTE` The fully-qualified class name of the custom AuditHandler implementation to execute.
`static java.lang.String` | `CLASS_NAME` The name of the ClassObject representing this class.
`static java.lang.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 java.lang.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.

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
`protected` | `AuditHandlerSpecification(LibrarySession session, java.lang.Long id, java.lang.Long classId, S_LibraryObjectData data)` Constructs an AuditHandlerSpecification object.

Method Summary
`java.lang.String` | `getAgentIdentifier()` Returns the identifier of the EventHandlerAgent instance responsible for servicing this handler.
`java.lang.String` | `getAuditHandlerClassName()` Returns the fully-qualified class name of the AuditHandler implementation to execute.
`java.lang.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.
`java.lang.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` | `preFree(LibraryObjectDefinition lodef)` Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
`void` | `removeHandlerProperty(java.lang.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, isActive, postCreate, postUpdate, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists`

Methods inherited from class oracle.ifs.beans.LibraryObject
`applyProperties, auditCreated, auditUpdated, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, deriveDomainUniqueName, dispose, equals, free, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, hasNameAttribute, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isTraced, isValidEventType, lockRows, lookupInstanceLabel, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeProperty, 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, verifySystemUserAccess, verifyTargetObject`

Methods inherited from class java.lang.Object
`clone, equals, 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 java.lang.String CLASS_NAME

  Description copied from class: `AuditHandlerSpecification`
  The name of the ClassObject representing this class.

  See Also:
    Constant Field Values

### HANDLERTYPE_ATTRIBUTE

    public static final java.lang.String HANDLERTYPE_ATTRIBUTE

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

  See Also:
    Constant Field Values

### AUDITHANDLERCLASSNAME_ATTRIBUTE

    public static final java.lang.String AUDITHANDLERCLASSNAME_ATTRIBUTE

  Description copied from class: `AuditHandlerSpecification`
  The fully-qualified class name of the custom AuditHandler implementation to execute. (String[200])

  See Also:
    Constant Field Values

### AGENTIDENTIFIER_ATTRIBUTE

    public static final java.lang.String AGENTIDENTIFIER_ATTRIBUTE

  Description copied from class: `AuditHandlerSpecification`
  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 java.lang.String NONCOMPETING_ATTRIBUTE

  Description copied from class: `AuditHandlerSpecification`
  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

### HANDLERTYPE_NONE

    public static final int HANDLERTYPE_NONE

  Description copied from class: `AuditHandlerSpecification`
  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

  Description copied from class: `AuditHandlerSpecification`
  An option for the HANDLERTYPE attribute, indicating a regular handler.

  See Also:
    Constant Field Values

### HANDLERTYPE_INTERNAL

    public static final int HANDLERTYPE_INTERNAL

  Description copied from class: `AuditHandlerSpecification`
  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

  Description copied from class: `AuditHandlerSpecification`
  An option for the HANDLERTYPE attribute, indicating some other custom handler.

  See Also:
    Constant Field Values

Constructor Detail

### AuditHandlerSpecification

    protected AuditHandlerSpecification(LibrarySession session,
                                        java.lang.Long id,
                                        java.lang.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

  Description copied from class: `AuditHandlerSpecification`
  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 java.lang.String getAuditHandlerClassName()
                                              throws IfsException

  Description copied from class: `AuditHandlerSpecification`
  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 java.lang.String getAgentIdentifier()
                                        throws IfsException

  Description copied from class: `AuditHandlerSpecification`
  Returns the identifier of the EventHandlerAgent instance responsible for servicing this handler.

  A null value indicates that the default agent instance is responsible for servicing this handler.

  Returns:
    the identifier of the agent instance responsible for servicing this handler
  Throws:
    `IfsException` - if the operation fails

### isNonCompeting

    public boolean isNonCompeting()
                           throws IfsException

  Description copied from class: `AuditHandlerSpecification`
  Gets the non-competing status.

  Returns:
    true if the handler is non-competing; false otherwise
  Throws:
    `IfsException` - if operation fails
  (Published)

### removeHandlerProperty

    public void removeHandlerProperty(java.lang.String key)
                               throws IfsException

  Description copied from class: `AuditHandlerSpecification`
  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

  Description copied from class: `AuditHandlerSpecification`
  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 java.lang.String getTimerPeriodProperty()
                                            throws IfsException

  Description copied from class: `AuditHandlerSpecification`
  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 java.lang.String getBaseTimeOfDayProperty()
                                              throws IfsException

  Description copied from class: `AuditHandlerSpecification`
  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.

### 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.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD