oracle.ifs.core.handlers

Class FolderIndexDispatchingHandler

java.lang.Object

oracle.ifs.core.handlers.AuditEventHandlerAdapter

oracle.ifs.core.handlers.DispatchingHandler

oracle.ifs.core.handlers.FolderIndexDispatchingHandler

All Implemented Interfaces:

AuditEventHandler

public class FolderIndexDispatchingHandler
extends DispatchingHandler

FolderIndexDispatchingHandler is a handler class that manages FolderIndex partitions.

Author:

Dave Long

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderIndexDispatchingHandler.FolderIndexDispatchingHandlerState FolderIndexDispatchingHandlerState extends the generic state used for dispatching handlers, to inject logic specific to the FolderIndexDispatchingHandler.

Field Summary

Fields inherited from class oracle.ifs.core.handlers.DispatchingHandler

PROPERTY_DEFAULT_BATCHSIZE, PROPERTY_NAME_BATCHSIZE, PROPERTY_NAME_CONTINUOUS_WORKER_MODE_ENABLED, PROPERTY_NAME_DISPATCHINGHANDLERSPECIFICATION, PROPERTY_NAME_DYNAMIC_BATCHSIZE_ENABLED, PROPERTY_NAME_FORCE_RETRY_OF_FAILURES, PROPERTY_NAME_MAXIMUM_WORKER_QUEUE_SIZE, PROPERTY_NAME_PENDING_EVENTSET_NAMES, PROPERTY_NAME_PROCESS_EVENTS_WHEN_NEW_EVENT_POSTED, PROPERTY_NAME_PROCESS_EVENTS_WITH_TIMER, PROPERTY_NAME_REQUEUE_UPON_FAILURE, PROPERTY_NAME_RETRY_PHASE_PERIODS, PROPERTY_NAME_RETRY_UPON_FAILURE

Fields inherited from class oracle.ifs.core.handlers.AuditEventHandlerAdapter

DEFAULT_BATCHSIZE

Constructor Summary

Constructors

Constructor and Description
FolderIndexDispatchingHandler()

Method Summary

Modifier and Type	Method and Description
protected DispatchingHandlerState	constructDispatchingHandlerState() Constructs the DispatchingHandlerState.
void	handleTimerExpired(AuditEventHandlerContext context) Called when the timer for this AuditEventHandler expires.
protected void	initializeNonDynamicProperties(AuditEventHandlerContext context) Initialize the member variables for the non-dynamic handler properties Any updates to these properties are not recognized by the handler while it is running.
protected void	processEvent(LibrarySession session, AuditEvent event, DispatchedEvent de) Low-level processing of an event.
protected void	refreshDynamicProperties(AuditEventHandlerContext context) Refresh the member variables for the dynamic handler properties.

Methods inherited from class oracle.ifs.core.handlers.DispatchingHandler

addPendingEventSetName, checkDispatchingHandlerSpecificationRequests, checkForCompletedEventSets, checkForNewPendingEventSetName, completeEventSet, deriveDispatcherDynamicBatchSize, deriveWorkerDynamicBatchSize, determineDispatchingHandlerSpecification, getBatchSize, getCommonName, getDispatchingHandlerSpecification, getDispatchingHandlerState, getDynamicBatchSize, getEstimatedCost, getEventSetName, getMaximumWorkerQueueSize, getPendingEventSetNames, getRetryPhasePeriods, handleEventPosted, handleInitialize, hasAuxDispatchingHandlerSpecifications, incrementSkipCount, isContinuousWorkerModeEnabled, isDynamicBatchSizeEnabled, isForceRetryFailuresEnabled, isProcessEventsWhenNewEventPostedEnabled, isProcessEventsWithTimerEnabled, isRequeueUponFailureEnabled, isRetryUponFailureEnabled, markProcessingCompleted, processEvent, processEvents, processExistingDispatchedEvent, rebalanceActiveWorkers, rebalanceInactiveWorkers, rebalanceWorker, setForceRetryAllFailuresNextBatch, setForceRetryFailuresNextBatch, setProcessingStarted

Methods inherited from class oracle.ifs.core.handlers.AuditEventHandlerAdapter

deleteEvents, getAuditHandlerSpecification, getAuditSpecification, getHandlerProperty, handleDispose, markProcessingStarted, processEvents, processEvents, selectEvents, selectEvents, selectMaximumEventId, setHandlerProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderIndexDispatchingHandler

public FolderIndexDispatchingHandler()

Method Detail

initializeNonDynamicProperties

protected void initializeNonDynamicProperties(AuditEventHandlerContext context)
                                       throws IfsException

Initialize the member variables for the non-dynamic handler properties

Any updates to these properties are not recognized by the handler while it is running.

Overrides:

initializeNonDynamicProperties in class DispatchingHandler

Parameters:

context - the AuditEventHandlerContext

Throws:

IfsException - if the operation fails

refreshDynamicProperties

protected void refreshDynamicProperties(AuditEventHandlerContext context)
                                 throws IfsException

Refresh the member variables for the dynamic handler properties.

Any updates to these properties are recognized by the handler at the next timer interval.

Overrides:

refreshDynamicProperties in class DispatchingHandler

Parameters:

context - the AuditEventHandlerContext

Throws:

IfsException - if the operation fails

handleTimerExpired

public void handleTimerExpired(AuditEventHandlerContext context)
                        throws Exception

Description copied from class: AuditEventHandlerAdapter

Called when the timer for this AuditEventHandler expires.

Specified by:

handleTimerExpired in interface AuditEventHandler

Overrides:

handleTimerExpired in class DispatchingHandler

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

constructDispatchingHandlerState

protected DispatchingHandlerState constructDispatchingHandlerState()
                                                            throws IfsException

Description copied from class: DispatchingHandler

Constructs the DispatchingHandlerState.

This is typically overridden by subclasses that wish to add custom dispatching logic.

Overrides:

constructDispatchingHandlerState in class DispatchingHandler

Returns:

a newly constructed state instance

Throws:

IfsException - if the opertation fails

processEvent

protected void processEvent(LibrarySession session,
                            AuditEvent event,
                            DispatchedEvent de)
                     throws IfsException

Description copied from class: DispatchingHandler

Low-level processing of an event.

Specified by:

processEvent in class DispatchingHandler

Parameters:

session - the session Context to use for processing

event - the event to process

de - the associated DispatchedEvent

Throws:

IfsException - if the operation fails