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.util
Class AuditEventHandlerContext

All Known Implementing Classes:
  AuditEventHandlerContextImpl, EventHandlerAgent.InternalHandler

    public interface class AuditEventHandlerContext

Processing context used by AuditEventHandler implementations.

Method Summary
`LibrarySession` | `acquireAuxiliarySession()` Acquires an additional session context to use for processing.
`AuditSpecification` | `getAuditSpecification()` Returns the custom Audit Specification corresponding to the "Audit History" associated with this handler, indicating where the AuditEvents are posted.
`java.lang.Long` | `getAuditSpecificationId()` Returns the custom Audit Specification ID corresponding to the "Audit History" associated with this handler, indicating where the AuditEvents are posted.
`AttributeValue` | `getHandlerProperty(java.lang.String key)` Gets a property of the custom Audit Specification by its property name.
`LibrarySession` | `getLibrarySession()` Returns the session context to use for processing.
`long` | `getMinimumDispatchedEventId()` Returns the minimum event ID encountered when AuditEvents were last dispatched in the handler.
`long` | `getNextSequenceId()` Returns the next sequence ID value that would have been leveraged for a new Object created in the repository.
`AttributeValue` | `getNodeProperty(java.lang.String key)` Gets a property of the running Node context.
`AttributeValue` | `getServerProperty(java.lang.String key)` Gets a property of the running Server context.
`boolean` | `isDeactivated()` Determines whether a deactivation has occurred for this handler, indicated that it should complete processing the current operation as soon as possible.
`void` | `purgeEvent(AuditEvent event)` Purges an AuditEvent from its audit history.
`void` | `purgeEvents(AuditEvent[] events)` Purges a set of AuditEvents from their audit histories.
`void` | `removeHandlerProperty(java.lang.String key)` Removes a property of the custom Audit Specification by its property name.
`void` | `restartAuditEventHandler()` Causes a reset of the handler settings.
`void` | `setDomainId(long domainId)` Sets the Domain that should be used while processing an AuditEvent.
`void` | `setHandlerProperty(java.lang.String key, AttributeValue value)` Sets a property of the custom Audit Specification.

Method Detail

### getLibrarySession

    LibrarySession getLibrarySession()

  Description copied from interface: `AuditEventHandlerContext`
  Returns the session context to use for processing.

  Returns:
    the session context to use for processing

### acquireAuxiliarySession

    LibrarySession acquireAuxiliarySession()
                                           throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Acquires an additional session context to use for processing.

  Returns:
    the new session context
  Throws:
    `IfsException` - if the operation fails

### getAuditSpecificationId

    java.lang.Long getAuditSpecificationId()

  Description copied from interface: `AuditEventHandlerContext`
  Returns the custom Audit Specification ID corresponding to the "Audit History" associated with this handler, indicating where the AuditEvents are posted.

  Use this ID when using `AuditingUtilities.searchAuditHistory` to find AuditEvents that have occurred that are of interest to this handler.

  Returns:
    the ID of the Audit Specification

### getAuditSpecification

    AuditSpecification getAuditSpecification()
                                             throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Returns the custom Audit Specification corresponding to the "Audit History" associated with this handler, indicating where the AuditEvents are posted.

  Returns:
    the Audit Specification
  Throws:
    `IfsException` - if the operation fails

### getHandlerProperty

    AttributeValue getHandlerProperty(java.lang.String key)
                                      throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Gets a property of the custom Audit Specification by its property name.

  Parameters:
    `key` - the Audit Specification property key
  Returns:
    the property value, or null if not defined
  Throws:
    `IfsException` - if the operation fails

### setHandlerProperty

    void setHandlerProperty(java.lang.String key,
                            AttributeValue value)
                            throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Sets a property of the custom Audit Specification.

  Parameters:
    `key` - the Audit Specification property key
    `value` - the Audit Specification property value
  Throws:
    `IfsException` - if the operation fails

### removeHandlerProperty

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

  Description copied from interface: `AuditEventHandlerContext`
  Removes a property of the custom Audit Specification by its property name.

  Parameters:
    `key` - the Audit Specification property key
  Throws:
    `IfsException` - if the operation fails

### getServerProperty

    AttributeValue getServerProperty(java.lang.String key)
                                     throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Gets a property of the running Server context.

  Parameters:
    `key` - the Server property key
  Returns:
    the property value, or null if not defined
  Throws:
    `IfsException` - if the operation fails

### getNodeProperty

    AttributeValue getNodeProperty(java.lang.String key)
                                   throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Gets a property of the running Node context.

  Parameters:
    `key` - the Node property key
  Returns:
    the property value, or null if not defined
  Throws:
    `IfsException` - if the operation fails

### setDomainId

    void setDomainId(long domainId)
                     throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Sets the Domain that should be used while processing an AuditEvent.

  By default, this is the default Domain. In a multi-Domain instance, this must be set to the ID of the Domain for the AuditEvent that is being processed, because an AuditEventHandler will be invoked for Events that have occurred in any Domain in the instance.

  A value of zero for the Domain ID will effectively clear the previously established Domain context.

  Parameters:
    `domainId` - the ID of the Domain to use while processing an Event or zero to clear the previously established Domain context
  Throws:
    `IfsException` - if the operation fails

### restartAuditEventHandler

    void restartAuditEventHandler()
                                  throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Causes a reset of the handler settings.

  Throws:
    `IfsException` - if the operation fails

### purgeEvent

    void purgeEvent(AuditEvent event)
                    throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Purges an AuditEvent from its audit history.

  Parameters:
    `event` - the AuditEvent to purge
  Throws:
    `IfsException` - if the operation fails

### purgeEvents

    void purgeEvents(AuditEvent[] events)
                     throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Purges a set of AuditEvents from their audit histories.

  Parameters:
    `events` - the AuditEvents to purge
  Throws:
    `IfsException` - if the operation fails

### isDeactivated

    boolean isDeactivated()

  Description copied from interface: `AuditEventHandlerContext`
  Determines whether a deactivation has occurred for this handler, indicated that it should complete processing the current operation as soon as possible.

  Returns:
    true if the handler has been deactivated

### getNextSequenceId

    long getNextSequenceId()
                           throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Returns the next sequence ID value that would have been leveraged for a new Object created in the repository. This ID can be used as a high water mark when processing batches of Items.

  Returns:
    the ID of the next Item that will be created
  Throws:
    `IfsException` - if the operation fails

### getMinimumDispatchedEventId

    long getMinimumDispatchedEventId()
                                     throws IfsException

  Description copied from interface: `AuditEventHandlerContext`
  Returns the minimum event ID encountered when AuditEvents were last dispatched in the handler.

  Returns:
    the minimum dispatched event ID
  Throws:
    `IfsException` - if the 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