DispatchingHandler (ecmsdk-api 3.7.0 API)

java.lang.Object
- oracle.ifs.core.handlers.AuditEventHandlerAdapter
- - oracle.ifs.core.handlers.DispatchingHandler

All Implemented Interfaces:

AuditEventHandler

Direct Known Subclasses:

CombinedPlateAppearanceHandler, FolderIndexDispatchingHandler, PlateAppearanceDispatchingHandler, SimpleCombinedPlateAppearanceHandler, SimpleFastLaneHandler, SimpleRetryOnErrorHandler
```
public abstract class DispatchingHandler
extends AuditEventHandlerAdapter
```
DispatchingHandler is an abstract handler which dispatches the AuditEvents it receives to other Workers, as defined by a DispatchingHandlerSpecification, or processes them directly if there are no Workers defined.

Author:

Dave Long

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PROPERTY_DEFAULT_BATCHSIZE` Default value for Handler property PROPERTY_NAME_BATCHSIZE.
`static String`	`PROPERTY_NAME_BATCHSIZE` Handler property that specifies the batch size to use for selecting AuditEvents (an INTEGER).
`static String`	`PROPERTY_NAME_CONTINUOUS_WORKER_MODE_ENABLED` Handler property used to indicate if Continuous Worker mode is enabled.
`static String`	`PROPERTY_NAME_DISPATCHINGHANDLERSPECIFICATION` Handler property that specifies the DispatchingHandlerSpecification which encapsulates the details about the Workers (a SystemObject specifying the DispatchingHandlerSpecification).
`static String`	`PROPERTY_NAME_DYNAMIC_BATCHSIZE_ENABLED` Handler property used to track whether dynamic BatchSize is enabled - where the batchsize is modified based on current conditions, such as taking into account DispatchedEvents in a fail/retry phase.
`static String`	`PROPERTY_NAME_FORCE_RETRY_OF_FAILURES` Handler property used to track whether to force a retry of the first previous failure once we see a successful event processed.
`static String`	`PROPERTY_NAME_MAXIMUM_WORKER_QUEUE_SIZE` Handler property used to track the maximum event queue size for any single Worker (Integer).
`static String`	`PROPERTY_NAME_PENDING_EVENTSET_NAMES` Handler property that holds the pending Event Set names, for Event Sets dispatched and now awaiting completion.
`static String`	`PROPERTY_NAME_PROCESS_EVENTS_WHEN_NEW_EVENT_POSTED` Handler property used to track whether event processing should occur when a new event is posted (BOOLEAN).
`static String`	`PROPERTY_NAME_PROCESS_EVENTS_WITH_TIMER` Handler property used to track whether event processing should occur as part of timer handling (BOOLEAN).
`static String`	`PROPERTY_NAME_REQUEUE_UPON_FAILURE` Handler property used to track whether failed event processing should result in requeuing back to dispatcher.
`static String`	`PROPERTY_NAME_RETRY_PHASE_PERIODS` Handler property used to hold the time periods for each retry-upon-failure phase.
`static String`	`PROPERTY_NAME_RETRY_UPON_FAILURE` Handler property used to indicate if retry-upon-failure is enabled.

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

Constructor Summary

Constructors
Constructor and Description

DispatchingHandler()

Constructors
Constructor and Description
`DispatchingHandler()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addPendingEventSetName(AuditEventHandlerContext context, String setName)` Adds a new pending Event Set name.
`protected void`	`checkDispatchingHandlerSpecificationRequests(AuditEventHandlerContext context)` Checks to see if there are any DispatchingHandlerSpecification requests.
`void`	`checkForCompletedEventSets(AuditEventHandlerContext context)` Checks any pending Event Sets to see if all associated DispatchedEvents have been completed.
`protected void`	`checkForNewPendingEventSetName(AuditEventHandlerContext context, AuditEvent event)` Check to see if we now have a new Pending Event Set name that the dispatcher should track to see when all of the events have been processed.
`protected void`	`completeEventSet(AuditEventHandlerContext context, String setName)` Perform operations associated with a completed Event Set.
`protected DispatchingHandlerState`	`constructDispatchingHandlerState()` Constructs the DispatchingHandlerState.
`protected int`	`deriveDispatcherDynamicBatchSize(LibrarySession session, DispatchingHandlerState state, int baseSize)` Gets the dynamic batch size, dervied as adjustments to the base batchSize specified.
`protected int`	`deriveWorkerDynamicBatchSize(LibrarySession session, int baseSize)` Gets the dynamic batch size, dervied as adjustments to the base batchSize specified.
`protected DispatchingHandlerSpecification`	`determineDispatchingHandlerSpecification(LibrarySession session, AuditEvent event)` Determine the DispatchingHandlerSpecification that should be used for the specificed event.
`protected int`	`getBatchSize()` Gets the batch size.
`protected String`	`getCommonName()` Gets the common name for this handler, useful for logging.
`protected DispatchingHandlerSpecification`	`getDispatchingHandlerSpecification(AuditEventHandlerContext context)` Gets the DispatchingHandlerSpecification.
`protected DispatchingHandlerState`	`getDispatchingHandlerState()` Gets the DispatchingHandlerState.
`protected int`	`getDynamicBatchSize(LibrarySession session, int baseSize)` Gets the dynamic batch size, dervied as adjustments to the base batchSize specified.
`Integer`	`getEstimatedCost(LibrarySession session, AuditEvent event)` Gets the estimated cost of processing the specified event.
`String`	`getEventSetName(LibrarySession session, AuditEvent event)` Gets the EventSet name from the specified event.
`int`	`getMaximumWorkerQueueSize()` Gets maximum event queue size for any single Worker.
`protected String[]`	`getPendingEventSetNames(LibrarySession session)` Gets the current Event set names.
`protected String[]`	`getRetryPhasePeriods()` Gets the retry-upon-failure time periods, as Strings such as "5M".
`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 boolean`	`hasAuxDispatchingHandlerSpecifications(AuditEventHandlerContext context)` Checks if auxiliary DispatchingHandlerSpecifications will be used.
`void`	`incrementSkipCount()` Increment our "skipped event" count.
`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 boolean`	`isContinuousWorkerModeEnabled()` Gets whether Continuous Worker Mode is enabled.
`protected boolean`	`isDynamicBatchSizeEnabled()` Gets whether dynamic BatchSize is enabled, where the batchsize is modified based on current conditions, such as taking into account DispatchedEvents in a fail/retry phase.
`protected boolean`	`isForceRetryFailuresEnabled()` Gets whether to force a retry of the first previous failure once we see a successful event processed.
`protected boolean`	`isProcessEventsWhenNewEventPostedEnabled()` Gets whether event processing should occur when a new event gets posted.
`protected boolean`	`isProcessEventsWithTimerEnabled()` Gets whether event processing should occur as part of timer handling.
`protected boolean`	`isRequeueUponFailureEnabled()` Gets whether failed event processing should result in requeuing back to dispatcher.
`protected boolean`	`isRetryUponFailureEnabled()` Gets whether retry-upon-failure is enabled.
`protected void`	`markProcessingCompleted(AuditEventHandlerContext context, AuditEvent event, DispatchedEvent de)` Mark "Processing Completed" on the specified DispatchedEvent and purge the associated AuditEvent.
`protected void`	`processEvent(AuditEventHandlerContext context, AuditEvent event)` Process the specified event.
`protected abstract void`	`processEvent(LibrarySession session, AuditEvent event, DispatchedEvent de)` Low-level processing of an event.
`protected void`	`processEvents(AuditEventHandlerContext context, int batchSize)` Handle events by performing the requested operations, using the specified batch size.
`protected void`	`processExistingDispatchedEvent(AuditEventHandlerContext context, AuditEvent event, DispatchedEvent de)` Process an event that already has an existing DispatchedEvent defined, indicating that it was likely requeued by a Worker.
`protected void`	`rebalanceActiveWorkers(AuditEventHandlerContext context, DispatchingHandlerState state)` Perform rebalancing of all events dispatched by this handler that are currently assigned to Active Workers.
`protected void`	`rebalanceInactiveWorkers(AuditEventHandlerContext context, DispatchingHandlerState state)` Perform rebalancing of all events dispatched by this handler that are currently assigned to Inactive Workers.
`protected void`	`rebalanceWorker(AuditEventHandlerContext context, DispatchingHandlerState state, AuditSpecification worker, boolean force)` Perform rebalancing of all events dispatched by this handler to the specified Worker..
`protected void`	`refreshDynamicProperties(AuditEventHandlerContext context)` Refresh the member variables for the dynamic handler properties.
`void`	`setForceRetryAllFailuresNextBatch()` Sets indication that all previous failures waiting to retry should ignore the timer and retry during the next batch.
`void`	`setForceRetryFailuresNextBatch()` Sets indication that the first previous failure waiting to retry should ignore the timer and retry during the next batch.
`protected DispatchedEvent`	`setProcessingStarted(AuditEventHandlerContext context, AuditEvent event, DispatchedEvent de)` Mark the specified DispatchedEvent as "Processing started" if this event is indeed to be processed.

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

- Field Detail
  - PROPERTY_NAME_DISPATCHINGHANDLERSPECIFICATION
```
public static final String PROPERTY_NAME_DISPATCHINGHANDLERSPECIFICATION
```
    Handler property that specifies the DispatchingHandlerSpecification which encapsulates the details about the Workers (a SystemObject specifying the DispatchingHandlerSpecification).
    Note: this property is only set on the Disptcher (not on Worker template).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_BATCHSIZE
```
public static final String PROPERTY_NAME_BATCHSIZE
```
    Handler property that specifies the batch size to use for selecting AuditEvents (an INTEGER).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_PENDING_EVENTSET_NAMES
```
public static final String PROPERTY_NAME_PENDING_EVENTSET_NAMES
```
    Handler property that holds the pending Event Set names, for Event Sets dispatched and now awaiting completion.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_PROCESS_EVENTS_WITH_TIMER
```
public static final String PROPERTY_NAME_PROCESS_EVENTS_WITH_TIMER
```
    Handler property used to track whether event processing should occur as part of timer handling (BOOLEAN).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_PROCESS_EVENTS_WHEN_NEW_EVENT_POSTED
```
public static final String PROPERTY_NAME_PROCESS_EVENTS_WHEN_NEW_EVENT_POSTED
```
    Handler property used to track whether event processing should occur when a new event is posted (BOOLEAN).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_REQUEUE_UPON_FAILURE
```
public static final String PROPERTY_NAME_REQUEUE_UPON_FAILURE
```
    Handler property used to track whether failed event processing should result in requeuing back to dispatcher.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_DYNAMIC_BATCHSIZE_ENABLED
```
public static final String PROPERTY_NAME_DYNAMIC_BATCHSIZE_ENABLED
```
    Handler property used to track whether dynamic BatchSize is enabled - where the batchsize is modified based on current conditions, such as taking into account DispatchedEvents in a fail/retry phase.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_MAXIMUM_WORKER_QUEUE_SIZE
```
public static final String PROPERTY_NAME_MAXIMUM_WORKER_QUEUE_SIZE
```
    Handler property used to track the maximum event queue size for any single Worker (Integer).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_RETRY_UPON_FAILURE
```
public static final String PROPERTY_NAME_RETRY_UPON_FAILURE
```
    Handler property used to indicate if retry-upon-failure is enabled.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_RETRY_PHASE_PERIODS
```
public static final String PROPERTY_NAME_RETRY_PHASE_PERIODS
```
    Handler property used to hold the time periods for each retry-upon-failure phase.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_FORCE_RETRY_OF_FAILURES
```
public static final String PROPERTY_NAME_FORCE_RETRY_OF_FAILURES
```
    Handler property used to track whether to force a retry of the first previous failure once we see a successful event processed.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_CONTINUOUS_WORKER_MODE_ENABLED
```
public static final String PROPERTY_NAME_CONTINUOUS_WORKER_MODE_ENABLED
```
    Handler property used to indicate if Continuous Worker mode is enabled.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DEFAULT_BATCHSIZE
```
public static final int PROPERTY_DEFAULT_BATCHSIZE
```
    Default value for Handler property PROPERTY_NAME_BATCHSIZE.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DispatchingHandler
```
public DispatchingHandler()
```
- Method Detail
  - handleInitialize
```
public void handleInitialize(AuditEventHandlerContext context)
                      throws Exception
```
    Description copied from class: AuditEventHandlerAdapter
    
    Initializes this handler.
    Called immediately after construction.
    
    Specified by:
    
    handleInitialize in interface AuditEventHandler
    
    Overrides:
    
    handleInitialize in class AuditEventHandlerAdapter
    
    Parameters:
    
    context - the AuditEventHandlerContext to use for processing
    
    Throws:
    
    Exception - 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 AuditEventHandlerAdapter
    
    Parameters:
    
    context - the AuditEventHandlerContext to use for processing
    
    Throws:
    
    Exception - if the operation fails
  - handleEventPosted
```
public void handleEventPosted(AuditEventHandlerContext context)
                       throws Exception
```
    Description copied from class: AuditEventHandlerAdapter
    
    Called when at least one registered event is posted.
    
    Specified by:
    
    handleEventPosted in interface AuditEventHandler
    
    Overrides:
    
    handleEventPosted in class AuditEventHandlerAdapter
    
    Parameters:
    
    context - the AuditEventHandlerContext to use for processing
    
    Throws:
    
    Exception - if the operation fails
  - 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.
    
    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.
    
    Parameters:
    
    context - the AuditEventHandlerContext
    
    Throws:
    
    IfsException - if the operation fails
  - getCommonName
```
protected String getCommonName()
```
    Gets the common name for this handler, useful for logging.
    
    Returns:
    
    the handler's common name
  - isProcessEventsWithTimerEnabled
```
protected boolean isProcessEventsWithTimerEnabled()
                                           throws IfsException
```
    Gets whether event processing should occur as part of timer handling.
    
    Returns:
    
    true iff events are processed as part of timer event
    
    Throws:
    
    IfsException - if the operation fails
  - isProcessEventsWhenNewEventPostedEnabled
```
protected boolean isProcessEventsWhenNewEventPostedEnabled()
                                                    throws IfsException
```
    Gets whether event processing should occur when a new event gets posted.
    
    Returns:
    
    true iff events are processed when a new event gets posted.
    
    Throws:
    
    IfsException - if the operation fails
  - isRequeueUponFailureEnabled
```
protected boolean isRequeueUponFailureEnabled()
                                       throws IfsException
```
    Gets whether failed event processing should result in requeuing back to dispatcher.
    
    Returns:
    
    true iff failed event processing results in requeuing back to dispatcher
    
    Throws:
    
    IfsException - if the operation fails
  - isRetryUponFailureEnabled
```
protected boolean isRetryUponFailureEnabled()
                                     throws IfsException
```
    Gets whether retry-upon-failure is enabled.
    
    Returns:
    
    true iff retry-upon-failure is enabled
    
    Throws:
    
    IfsException - if the operation fails
  - isDynamicBatchSizeEnabled
```
protected boolean isDynamicBatchSizeEnabled()
                                     throws IfsException
```
    Gets whether dynamic BatchSize is enabled, where the batchsize is modified based on current conditions, such as taking into account DispatchedEvents in a fail/retry phase.
    
    Returns:
    
    true iff dynamic BatchSize is enabled
    
    Throws:
    
    IfsException - if the operation fails
  - isContinuousWorkerModeEnabled
```
protected boolean isContinuousWorkerModeEnabled()
                                         throws IfsException
```
    Gets whether Continuous Worker Mode is enabled.
    
    Returns:
    
    true iff Continuous Worker Mode is enabled
    
    Throws:
    
    IfsException - if the operation fails
  - getRetryPhasePeriods
```
protected String[] getRetryPhasePeriods()
                                 throws IfsException
```
    Gets the retry-upon-failure time periods, as Strings such as "5M".
    
    Returns:
    
    the retry-upon-failure time periods
    
    Throws:
    
    IfsException - if the operation fails
  - isForceRetryFailuresEnabled
```
protected boolean isForceRetryFailuresEnabled()
                                       throws IfsException
```
    Gets whether to force a retry of the first previous failure once we see a successful event processed.
    
    Returns:
    
    true iff Force Retry Failures is enabled
    
    Throws:
    
    IfsException - if the operation fails
  - getDispatchingHandlerSpecification
```
protected DispatchingHandlerSpecification getDispatchingHandlerSpecification(AuditEventHandlerContext context)
                                                                      throws IfsException
```
    Gets the DispatchingHandlerSpecification.
    
    Parameters:
    
    context - the handler context
    
    Returns:
    
    the DispatchingHandlerSpecification
    
    Throws:
    
    IfsException - if the operation fails
  - hasAuxDispatchingHandlerSpecifications
```
protected boolean hasAuxDispatchingHandlerSpecifications(AuditEventHandlerContext context)
                                                  throws IfsException
```
    Checks if auxiliary DispatchingHandlerSpecifications will be used.
    
    Parameters:
    
    context - the handler context
    
    Returns:
    
    true if there are auxiliary DispatchingHandlerSpecifications
    
    Throws:
    
    IfsException - if the operation fails
  - determineDispatchingHandlerSpecification
```
protected DispatchingHandlerSpecification determineDispatchingHandlerSpecification(LibrarySession session,
                                                                                   AuditEvent event)
                                                                            throws IfsException
```
    Determine the DispatchingHandlerSpecification that should be used for the specificed event.
    This is called when auxiliary DispatchingHandlerSpecifications are enabled. This is overridfden by subclasses that use auxiliary DispatchingHandlerSpecifications; the default implementation just returns null;
    
    Parameters:
    
    context - the handler context
    
    Returns:
    
    true if there are auxiliary DispatchingHandlerSpecifications
    
    Throws:
    
    IfsException - if the operation fails
  - getMaximumWorkerQueueSize
```
public int getMaximumWorkerQueueSize()
                              throws IfsException
```
    Gets maximum event queue size for any single Worker.
    A value of 0 implies no maximum.
    
    Returns:
    
    the maximum Worker queue size
    
    Throws:
    
    IfsException - if the operation fails
  - getBatchSize
```
protected int getBatchSize()
                    throws IfsException
```
    Gets the batch size.
    
    Returns:
    
    the batch size
    
    Throws:
    
    IfsException - if the operation fails
  - getDynamicBatchSize
```
protected int getDynamicBatchSize(LibrarySession session,
                                  int baseSize)
                           throws IfsException
```
    Gets the dynamic batch size, dervied as adjustments to the base batchSize specified.
    
    Parameters:
    
    session - the session context
    
    baseSize - the base batch size, fromthe handler property setting
    
    Returns:
    
    the dynamic batch size
    
    Throws:
    
    IfsException - if the operation fails
  - deriveDispatcherDynamicBatchSize
```
protected int deriveDispatcherDynamicBatchSize(LibrarySession session,
                                               DispatchingHandlerState state,
                                               int baseSize)
                                        throws IfsException
```
    Gets the dynamic batch size, dervied as adjustments to the base batchSize specified.
    
    Parameters:
    
    session - the session context
    
    state - the DispatchingHandlerState
    
    baseSize - base batch size, from the handler property setting
    
    Returns:
    
    the dynamic batch size
    
    Throws:
    
    IfsException - if the operation fails
  - deriveWorkerDynamicBatchSize
```
protected int deriveWorkerDynamicBatchSize(LibrarySession session,
                                           int baseSize)
                                    throws IfsException
```
    Gets the dynamic batch size, dervied as adjustments to the base batchSize specified.
    
    Parameters:
    
    session - the session context
    
    baseSize - the base batch size, fromthe handler property setting
    
    Returns:
    
    the dynamic batch size
    
    Throws:
    
    IfsException - if the operation fails
  - constructDispatchingHandlerState
```
protected DispatchingHandlerState constructDispatchingHandlerState()
                                                            throws IfsException
```
    Constructs the DispatchingHandlerState.
    This is typically overridden by subclasses that wish to add custom dispatching logic.
    
    Returns:
    
    a newly constructed state instance
    
    Throws:
    
    IfsException - if the opertation fails
  - getDispatchingHandlerState
```
protected DispatchingHandlerState getDispatchingHandlerState()
                                                      throws IfsException
```
    Gets the DispatchingHandlerState.
    
    Returns:
    
    the DispatchingHandlerState
    
    Throws:
    
    IfsException - if the operation fails
  - checkDispatchingHandlerSpecificationRequests
```
protected void checkDispatchingHandlerSpecificationRequests(AuditEventHandlerContext context)
                                                     throws IfsException
```
    Checks to see if there are any DispatchingHandlerSpecification requests.
    
    Parameters:
    
    context - the AuditEventHandlerContext
    
    Throws:
    
    IfsException - if the operation fails
  - processEvents
```
protected void processEvents(AuditEventHandlerContext context,
                             int batchSize)
                      throws IfsException
```
    Description copied from class: AuditEventHandlerAdapter
    
    Handle events by performing the requested operations, using the specified batch size.
    
    Overrides:
    
    processEvents in class AuditEventHandlerAdapter
    
    Parameters:
    
    context - the AuditEventHandlerContext to use for processing
    
    Throws:
    
    IfsException - if the operation fails
  - processEvent
```
protected void processEvent(AuditEventHandlerContext context,
                            AuditEvent event)
                     throws IfsException
```
    Process the specified event.
    
    Overrides:
    
    processEvent in class AuditEventHandlerAdapter
    
    Parameters:
    
    context - the AuditEventHandlerContext to use for processing
    
    event - the event to process
    
    Throws:
    
    IfsException - if the operation fails
  - incrementSkipCount
```
public void incrementSkipCount()
```
    Increment our "skipped event" count.
    For the dispatcher, this is called by DispatchinghandlerState when it cannot dispatch an event to a Worker.
    For a Worker, this is called whenever a failure is encountered, or when an event is skipped because it is dependent on an earlier event that has failed, when in Continuous Worker mode.
  - setProcessingStarted
```
protected DispatchedEvent setProcessingStarted(AuditEventHandlerContext context,
                                               AuditEvent event,
                                               DispatchedEvent de)
                                        throws IfsException
```
    Mark the specified DispatchedEvent as "Processing started" if this event is indeed to be processed.
    This is overridden by the DispatchingHandler if the event is to be skipped for some reason, such as when RetryOnFailure is set and the retry phase timer has not yet expired.
    
    Overrides:
    
    setProcessingStarted in class AuditEventHandlerAdapter
    
    Parameters:
    
    context - the AuditEventHandlerContext to use for processing
    
    event - the event being processed
    
    de - the DispatchedEvent to set "Processing Started" if appropriate
    
    Returns:
    
    the DispatchedEvent specified, or null if this handler should ignore this event for now
    
    Throws:
    
    IfsException - if the operation fails
  - markProcessingCompleted
```
protected void markProcessingCompleted(AuditEventHandlerContext context,
                                       AuditEvent event,
                                       DispatchedEvent de)
                                throws IfsException
```
    Mark "Processing Completed" on the specified DispatchedEvent and purge the associated AuditEvent.
    
    Overrides:
    
    markProcessingCompleted in class AuditEventHandlerAdapter
    
    Parameters:
    
    context - the AuditEventHandlerContext to use for processing
    
    event - the event to purge
    
    de - the DispatchedEvent
    
    Throws:
    
    IfsException - if the operation fails
  - setForceRetryFailuresNextBatch
```
public void setForceRetryFailuresNextBatch()
                                    throws IfsException
```
    Sets indication that the first previous failure waiting to retry should ignore the timer and retry during the next batch.
    If this first previous failure is successfully processed, subsequent failures will be retried also, until one fails. After any new failure, the retry of previous failures stops.
    
    Throws:
    
    IfsException - if the operation fails
  - setForceRetryAllFailuresNextBatch
```
public void setForceRetryAllFailuresNextBatch()
                                       throws IfsException
```
    Sets indication that all previous failures waiting to retry should ignore the timer and retry during the next batch.
    
    Throws:
    
    IfsException - if the operation fails
  - processExistingDispatchedEvent
```
protected void processExistingDispatchedEvent(AuditEventHandlerContext context,
                                              AuditEvent event,
                                              DispatchedEvent de)
                                       throws IfsException
```
    Process an event that already has an existing DispatchedEvent defined, indicating that it was likely requeued by a Worker.
    
    Parameters:
    
    context - the AuditEventHandlerContext to use for processing
    
    event - the event to process
    
    de - the existing DispatchedEvent
    
    Throws:
    
    IfsException - if the operation fails
  - checkForNewPendingEventSetName
```
protected void checkForNewPendingEventSetName(AuditEventHandlerContext context,
                                              AuditEvent event)
                                       throws IfsException
```
    Check to see if we now have a new Pending Event Set name that the dispatcher should track to see when all of the events have been processed.
    
    Parameters:
    
    session - the session context
    
    event - the event
    
    Throws:
    
    IfsException - if the operation fails.
  - getEventSetName
```
public String getEventSetName(LibrarySession session,
                              AuditEvent event)
                       throws IfsException
```
    Gets the EventSet name from the specified event.
    
    Parameters:
    
    session - the session context
    
    event - the event
    
    Returns:
    
    the EventSet name
    
    Throws:
    
    IfsException - if the operation fails.
  - getEstimatedCost
```
public Integer getEstimatedCost(LibrarySession session,
                                AuditEvent event)
                         throws IfsException
```
    Gets the estimated cost of processing the specified event.
    
    Parameters:
    
    session - the session context
    
    event - the event
    
    Returns:
    
    the estimated cost, or null if no estimate could be determined
    
    Throws:
    
    IfsException - if the operation fails.
  - completeEventSet
```
protected void completeEventSet(AuditEventHandlerContext context,
                                String setName)
                         throws IfsException
```
    Perform operations associated with a completed Event Set.
    
    Parameters:
    
    context - the handler context
    
    setName - the Event Set name that has completed
    
    Throws:
    
    IfsException - if the operation fails
  - processEvent
```
protected abstract void processEvent(LibrarySession session,
                                     AuditEvent event,
                                     DispatchedEvent de)
                              throws IfsException
```
    Low-level processing of an event.
    
    Parameters:
    
    session - the session Context to use for processing
    
    event - the event to process
    
    de - the associated DispatchedEvent
    
    Throws:
    
    IfsException - if the operation fails
  - rebalanceActiveWorkers
```
protected void rebalanceActiveWorkers(AuditEventHandlerContext context,
                                      DispatchingHandlerState state)
                               throws IfsException
```
    Perform rebalancing of all events dispatched by this handler that are currently assigned to Active Workers.
    
    Parameters:
    
    context - the AuditEventHandlerContext
    
    state - the DispatchingHandlerState
    
    Throws:
    
    IfsException - if the operation fails
  - rebalanceInactiveWorkers
```
protected void rebalanceInactiveWorkers(AuditEventHandlerContext context,
                                        DispatchingHandlerState state)
                                 throws IfsException
```
    Perform rebalancing of all events dispatched by this handler that are currently assigned to Inactive Workers.
    
    Parameters:
    
    context - the AuditEventHandlerContext
    
    state - the DispatchingHandlerState
    
    Throws:
    
    IfsException - if the operation fails
  - rebalanceWorker
```
protected void rebalanceWorker(AuditEventHandlerContext context,
                               DispatchingHandlerState state,
                               AuditSpecification worker,
                               boolean force)
                        throws IfsException
```
    Perform rebalancing of all events dispatched by this handler to the specified Worker..
    
    Parameters:
    
    context - the AuditEventHandlerContext
    
    state - the DispatchingHandlerState
    
    worker - the Worker whose events get requeued to dispatcher
    
    force - whether to also requeue events whose status is STATUSCODE_PROCESSING_STARTED
    
    Throws:
    
    IfsException - if the operation fails
  - checkForCompletedEventSets
```
public void checkForCompletedEventSets(AuditEventHandlerContext context)
                                throws IfsException
```
    Checks any pending Event Sets to see if all associated DispatchedEvents have been completed.
    Typically called by subclasses as part of their Timer handling, to check if any existing pending Event Sets have all of their events processed by the Workers.
    
    Parameters:
    
    context - the handler context
    
    Throws:
    
    IfsException - if the operation fails
  - getPendingEventSetNames
```
protected String[] getPendingEventSetNames(LibrarySession session)
                                    throws IfsException
```
    Gets the current Event set names.
    
    Parameters:
    
    session - the session context
    
    Returns:
    
    the pending event set names
    
    Throws:
    
    IfsException - if the operation fails
  - addPendingEventSetName
```
protected void addPendingEventSetName(AuditEventHandlerContext context,
                                      String setName)
                               throws IfsException
```
    Adds a new pending Event Set name.
    
    Parameters:
    
    session - the session context
    
    setName - the new pending Event Set name
    
    Throws:
    
    IfsException - if the operation fails

Class DispatchingHandler

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_NAME_DISPATCHINGHANDLERSPECIFICATION

PROPERTY_NAME_BATCHSIZE

PROPERTY_NAME_PENDING_EVENTSET_NAMES

PROPERTY_NAME_PROCESS_EVENTS_WITH_TIMER

PROPERTY_NAME_PROCESS_EVENTS_WHEN_NEW_EVENT_POSTED

PROPERTY_NAME_REQUEUE_UPON_FAILURE

PROPERTY_NAME_DYNAMIC_BATCHSIZE_ENABLED

PROPERTY_NAME_MAXIMUM_WORKER_QUEUE_SIZE

PROPERTY_NAME_RETRY_UPON_FAILURE

PROPERTY_NAME_RETRY_PHASE_PERIODS

PROPERTY_NAME_FORCE_RETRY_OF_FAILURES

PROPERTY_NAME_CONTINUOUS_WORKER_MODE_ENABLED

PROPERTY_DEFAULT_BATCHSIZE

Constructor Detail

DispatchingHandler

Method Detail

handleInitialize

handleTimerExpired

handleEventPosted

initializeNonDynamicProperties

refreshDynamicProperties

getCommonName

isProcessEventsWithTimerEnabled

isProcessEventsWhenNewEventPostedEnabled

isRequeueUponFailureEnabled

isRetryUponFailureEnabled

isDynamicBatchSizeEnabled

isContinuousWorkerModeEnabled

getRetryPhasePeriods

isForceRetryFailuresEnabled

getDispatchingHandlerSpecification

hasAuxDispatchingHandlerSpecifications

determineDispatchingHandlerSpecification

getMaximumWorkerQueueSize

getBatchSize

getDynamicBatchSize

deriveDispatcherDynamicBatchSize

deriveWorkerDynamicBatchSize

constructDispatchingHandlerState

getDispatchingHandlerState

checkDispatchingHandlerSpecificationRequests

processEvents

processEvent

incrementSkipCount

setProcessingStarted

markProcessingCompleted

setForceRetryFailuresNextBatch

setForceRetryAllFailuresNextBatch

processExistingDispatchedEvent

checkForNewPendingEventSetName

getEventSetName

getEstimatedCost

completeEventSet

processEvent

rebalanceActiveWorkers

rebalanceInactiveWorkers

rebalanceWorker

checkForCompletedEventSets

getPendingEventSetNames

addPendingEventSetName