oracle.ifs.core.handlers

Class AuditEventHandlerAdapter

java.lang.Object

oracle.ifs.core.handlers.AuditEventHandlerAdapter

All Implemented Interfaces:

AuditEventHandler

Direct Known Subclasses:

CrawlerHandler, DeleteAllAuditEventsHandler, HandlerDispatcher, InformationExtractionHandlerDispatcher, InterMediaAnnotationHandler, RuntimeStateHandler, ScriptHandler

public class AuditEventHandlerAdapter
extends Object
implements AuditEventHandler

AuditEventHandlerAdapter provides a base implementation of the AuditEventHandler interface, and provides implementations for common operations needed by specific AuditEventHandler implementations.

Author:

Dave Long

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BATCHSIZE The default batch size to use for event selection and processing.

Constructor Summary

Constructors

Constructor and Description
AuditEventHandlerAdapter()

Method Summary

Modifier and Type	Method and Description
protected int	deleteEvents(AuditEventHandlerContext context, long maxId) Deletes all events for this handler's AuditSpecification, up to and including the specified maximum event ID.
AuditHandlerSpecification	getAuditHandlerSpecification(LibrarySession session) Gets the AuditHandlerSpecification.
AuditSpecification	getAuditSpecification(LibrarySession session) Gets the AuditSpecification.
AttributeValue	getHandlerProperty(LibrarySession session, String key) Gets a handler's property using a sesson context.
void	handleDispose(AuditEventHandlerContext context) Called when the AuditEventHandler instance will no longer be used.
void	handleEventPosted(AuditEventHandlerContext context) Called when at least one registered event is posted.
void	handleInitialize(AuditEventHandlerContext context) Initializes this handler.
void	handleTimerExpired(AuditEventHandlerContext context) Called when the timer for this AuditEventHandler expires.
protected void	processEvent(AuditEventHandlerContext context, AuditEvent event) Process the specified event.
protected void	processEvents(AuditEventHandlerContext context) Handle events by performing the requested operations, using the default batch size.
protected void	processEvents(AuditEventHandlerContext context, int batchSize) Handle events by performing the requested operations, using the specified batch size.
protected AuditEvent[]	selectEvents(AuditEventHandlerContext context, String[] eventTypes, Long maxId, int batchSize) Selects all events for this handler's AuditSpecification, up to and including the specified maximum event ID, filtered by the specified event types.
protected AuditEvent[]	selectEvents(AuditEventHandlerContext context, String[] eventTypes, Long minId, Long maxId, int batchSize) Selects all events for this handler's AuditSpecification, using an ID range specified by optional min and max values.
protected long	selectMaximumEventId(AuditEventHandlerContext context) Selects the maximum event ID in use in this handler's AuditSpecification.
void	setHandlerProperty(LibrarySession session, String key, AttributeValue value) Sets a handler's property using a sesson context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_BATCHSIZE

public static final int DEFAULT_BATCHSIZE

The default batch size to use for event selection and processing.

See Also:

Constant Field Values

Constructor Detail

AuditEventHandlerAdapter

public AuditEventHandlerAdapter()

Method Detail

handleInitialize

public void handleInitialize(AuditEventHandlerContext context)
                      throws Exception

Initializes this handler.

Called immediately after construction.

Specified by:

handleInitialize in interface AuditEventHandler

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

getAuditSpecification

public AuditSpecification getAuditSpecification(LibrarySession session)
                                         throws IfsException

Gets the AuditSpecification.

Parameters:

session - The session context

Returns:

The AuditSpecification

Throws:

IfsException - if the operation fails

getAuditHandlerSpecification

public AuditHandlerSpecification getAuditHandlerSpecification(LibrarySession session)
                                                       throws IfsException

Gets the AuditHandlerSpecification.

Parameters:

session - The session context

Returns:

The AuditHandlerSpecification

Throws:

IfsException - if the operation fails

getHandlerProperty

public AttributeValue getHandlerProperty(LibrarySession session,
                                         String key)
                                  throws IfsException

Gets a handler's property using a sesson context.

Parameters:

session - The session context

key - The property key

Returns:

The property value, or null if not defined

Throws:

IfsException - if the operation fails

(Published)

setHandlerProperty

public void setHandlerProperty(LibrarySession session,
                               String key,
                               AttributeValue value)
                        throws IfsException

Sets a handler's property using a sesson context.

Parameters:

session - The session context

key - The property key

value - The property value

Throws:

IfsException - if the operation fails

(Published)

handleEventPosted

public void handleEventPosted(AuditEventHandlerContext context)
                       throws Exception

Called when at least one registered event is posted.

Specified by:

handleEventPosted in interface AuditEventHandler

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

handleTimerExpired

public void handleTimerExpired(AuditEventHandlerContext context)
                        throws Exception

Called when the timer for this AuditEventHandler expires.

Specified by:

handleTimerExpired in interface AuditEventHandler

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

handleDispose

public void handleDispose(AuditEventHandlerContext context)
                   throws Exception

Called when the AuditEventHandler instance will no longer be used.

The instance should release any resources it is holding that would not be automatically released as part of the object's garbage collection.

Specified by:

handleDispose in interface AuditEventHandler

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

processEvents

protected void processEvents(AuditEventHandlerContext context)
                      throws IfsException

Handle events by performing the requested operations, using the default batch size.

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

IfsException - if the operation fails

processEvents

protected void processEvents(AuditEventHandlerContext context,
                             int batchSize)
                      throws IfsException

Handle events by performing the requested operations, using the specified batch size.

Parameters:

context - the AuditEventHandlerContext to use for processing

batchsize - the batch size to use for processing

Throws:

IfsException - if the operation fails

processEvent

protected void processEvent(AuditEventHandlerContext context,
                            AuditEvent event)
                     throws IfsException

Process the specified event.

Parameters:

context - the AuditEventHandlerContext to use for processing

event - the event to process

Throws:

IfsException - if the operation fails

selectMaximumEventId

protected long selectMaximumEventId(AuditEventHandlerContext context)
                             throws IfsException

Selects the maximum event ID in use in this handler's AuditSpecification.

This event ID can be used during event or timer notification processing, so that processing occurs only the events posted up until the time the maximum event ID is determined, avoiding any race conditions with new events being posted during the processing.

Parameters:

context - the AuditEventHandlerContext to use for processing

Returns:

the maximum event ID in existence, or -1 if there are no events in the AuditSpecification

Throws:

IfsException - if the operation fails

selectEvents

protected AuditEvent[] selectEvents(AuditEventHandlerContext context,
                                    String[] eventTypes,
                                    Long maxId,
                                    int batchSize)
                             throws IfsException

Selects all events for this handler's AuditSpecification, up to and including the specified maximum event ID, filtered by the specified event types.

If a null or empty array is specified for the event types, all types are selected.

The array of returned events is sorted by event ID.

Parameters:

context - the AuditEventHandlerContext to use for processing

eventTypes - the event types of interest

maxId - the maximum event ID in existence; if null, do not use any maximum ID constraint

batchSize - the batch size

Returns:

the events that meet the search criteria

Throws:

IfsException - if the operation fails

selectEvents

protected AuditEvent[] selectEvents(AuditEventHandlerContext context,
                                    String[] eventTypes,
                                    Long minId,
                                    Long maxId,
                                    int batchSize)
                             throws IfsException

Selects all events for this handler's AuditSpecification, using an ID range specified by optional min and max values.

The min and/or max ID values specified will result in a search qualification that will be inclusive for either or both values specified.

The array of returned events is sorted by event ID.

Parameters:

context - the AuditEventHandlerContext to use for processing

eventTypes - the event types of interest

minId - minimum event ID to be searched for inclusively; if null, do not use any minimum ID constraint

minId - maximum event ID to be searched for inclusively; if null, do not use any maximum ID constraint

batchSize - the batch size

Returns:

the events that meet the search criteria

Throws:

IfsException - if the operation fails

deleteEvents

protected int deleteEvents(AuditEventHandlerContext context,
                           long maxId)
                    throws IfsException

Deletes all events for this handler's AuditSpecification, up to and including the specified maximum event ID.

Parameters:

context - the AuditEventHandlerContext to use for processing

maxId - the maximum event ID in existence

Returns:

the number of events deleted

Throws:

IfsException - if the operation fails