oracle.ifs.core.util

Class DispatchingHandlerState

java.lang.Object

oracle.ifs.core.util.DispatchingHandlerState

Direct Known Subclasses:

CombinedPlateAppearanceHandler.PlateAppearanceDispatchingHandlerState, FolderIndexDispatchingHandler.FolderIndexDispatchingHandlerState, PlateAppearanceDispatchingHandler.PlateAppearanceDispatchingHandlerState, SimpleFastLaneHandler.SimpleFastLaneHandlerState, SimpleRetryOnErrorHandler.SimpleRetryOnErrorHandlerState

public class DispatchingHandlerState
extends Object

DispatchingHandlerState holds state for a running dispatching handler that is configured to use a DispatchingHandlerSpecification.

Author:

Dave Long

(Published)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DispatchingHandlerState.WorkerState WorkerState holds info about a Worker, to be used for dispatching and other management.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DE_SETTING_EFFECTIVE_TARGETOBJECT DispatchedEvent setting that holds the effective target object of the event.
static String	DISPATCHING_POLICY_LEAST_LOADED_FASTLANE The dispatching Policy name used for a "least loaded" dispatching strategy where the first N Workers are used as a fast lane as compared to the other Workers.
static String	DISPATCHING_POLICY_LEASTLOADED Dispatching policy for choosing the handler that is least loaded from a processing cost perspective.
static String	DISPATCHING_POLICY_ROUNDROBIN Dispatching policy for simple round robin.
static String	SETTING_CONTINUOUS_WORKER_ENABLED DispatchingHandlerSpecification setting that indicates whether the same Worker should be used for processing events for the same effective target object referenced in the AuditEvent - also known as "Continuous Worker" mode.
static String	SETTING_NAME_DISPATCHING_POLICY DispatchingHandlerSpecification setting that specifies the dispatching policy.
static String	SETTING_NAME_DISPATCHING_POLICY_DEFAULT Default policy if not specified in the DispatchingHandlerSpecification.
static String	SETTING_NAME_DISPATCHING_POLICY_FAST_LANE_COUNT DispatchingHandlerSpecification setting that specifies the the number of "Fast Lanes" to use for certain dispatching policies.

Constructor Summary

Constructors

Constructor and Description
DispatchingHandlerState() Constructs a DispatchingHandlerState.

Method Summary

Modifier and Type	Method and Description
protected void	addDispatchedEvent(DispatchedEvent de) Adds a new DispatchedEvent to the Worker and to the list of DispatchedEvents issued by the dispatcher.
protected void	addDispatchedEvent(DispatchedEvent de, boolean addToList) Adds a new DispatchedEvent to the Worker and conditionally to the list of DispatchedEvents issued by the dispatcher.
protected void	addToEffectiveTargetObjectMap(DispatchedEvent de) Adds a DispatchedEvent to the "ContinuousWorkerEnabled" map if that option is enabled.
protected void	alertHandlers(LibrarySession session) Notify any handlers that we dispatched to
protected void	applyDispatchedEventSettings(DispatchedEvent de, AttributeValueTable deTable) Apply any DispatchedEvent settings that are present in the specified settings table.
void	beginEventBatch(LibrarySession session) Mark the beginning of processing a batch of events.
boolean	canDispatch() Gets whether the state reflects the ability to dispatch new events.
protected void	checkActiveWorkers(LibrarySession session) Checks to see if there are any changes to Active workers.
protected void	checkInactiveWorkers(LibrarySession session) Checks to see if any Inactive workers should have their handler deactivated.
protected DispatchingHandlerState.WorkerState	constructWorkerState(AuditSpecification worker) Constructs a WorkerState.
protected AuditSpecification	determineWorker(LibrarySession session, AuditEvent event, AttributeValueTable deTable) Determine the Worker to use for the next AuditEvent.
void	dispatchEvent(LibrarySession session, AuditEvent event) Dispatch a single event from a batch that selected.
void	endEventBatch(LibrarySession session) Mark the end of processing a batch of events.
protected void	finalizeDispatchedEventSettings(LibrarySession session, AuditEvent event, AttributeValueTable deTable) Finalize any DispatchedEvent settings that will eventually get stored on the newly created (or updated) DispatchedEvent.
protected AuditSpecification	getActiveWorkerForNextEvent(LibrarySession session, AuditEvent event, AttributeValueTable deTable) Gets the Worker that should receive the next event.
protected AuditSpecification	getActiveWorkerForNextEventLeastLoaded(LibrarySession session) Gets the Workers that should receive the next event, using "least loaded worker" policy.
protected AuditSpecification	getActiveWorkerForNextEventLeastLoaded(LibrarySession session, AuditSpecification[] workers) Gets the Worker that should receive the next event, using "least loaded worker" policy, using the specified set of Workers as possible candidates.
protected AuditSpecification	getActiveWorkerForNextEventRoundRobin(LibrarySession session) Gets the Worker that should receive the next event, using "round robin" policy.
AuditSpecification[]	getActiveWorkers(LibrarySession session) Gets the set of active Workers defined.
AuditSpecification[]	getAllWorkers(LibrarySession session) Gets the complete set of Workers defined.
DispatchedEvent[]	getDispatchedEvents(LibrarySession session) Gets the array of dispatched events.
AuditSpecification	getDispatchingAuditSpecification(LibrarySession session) Gets the Dispatching AuditSpecification.
DispatchingHandler	getDispatchingHandler() Gets the DispatchingHandler.
DispatchingHandlerSpecification	getDispatchingHandlerSpecification(LibrarySession session) Gets the DispatchingHandlerSpecification.
String	getDispatchingPolicy() Gets the dispatching policy in effect.
protected LibraryObject	getEffectiveTargetObjectForEvent(LibrarySession session, AuditEvent event) Get the effective target object for the specified event, used when "ContinuousWorkerEnabled" is enabled.
protected Long	getEffectiveTargetObjectIdForEvent(LibrarySession session, AuditEvent event) Get the effective target object ID for the specified event, used when "ContinuousWorkerEnabled" is enabled.
protected AuditSpecification	getLeastLoadedWorker(LibrarySession session, AuditSpecification[] workers) Gets the Worker that currently is least loaded, using the specified set of Workers as possible candidates.
protected AuditSpecification	getLeastLoadedWorkerWithFastLane(LibrarySession session, AuditEvent event, int fastlaneCount) Gets the Worker that should receive the next event, using "least loaded worker" policy, taking into account the number of "Fast Lanes" specified..
int	getMaximumWorkerQueueSize() Gets the maximum size of a Worker's event queue.
protected DispatchingHandlerState.WorkerState	getWorkerState(AuditSpecification worker) Get a WorkerState for the specified Worker's AuditSpecification.
Map<Long,DispatchingHandlerState.WorkerState>	getWorkerStateMap() Gets the map that holds Worker state, keyed by the worker's AuditSpecification ID.
void	handleTimerExpired(LibrarySession session) Handle tasks to be performed at the dispatcher's timer interval.
void	initialize(DispatchingHandler handler, AuditSpecification dispatcher, DispatchingHandlerSpecification dhSpec) Initializes a newly constructed DispatchingHandlerState instance.
protected void	initializeDispatchedEventSettings(LibrarySession session, AuditEvent event, AttributeValueTable deTable) Initialize any DispatchedEvent settings that will eventually get stored on the newly created (or updated) DispatchedEvent.
boolean	isContinuousWorkerEnabled() Gets indication as to whether the same Worker should be used for processing events for the same effective target object referenced in the AuditEvent - also known as "Continuous Worker" mode.
protected boolean	isFastLaneEvent(LibrarySession session, AuditEvent event) Checks the specified event to see if it should be considered a "fast lane" event.
protected void	markDispatchedWorker(AuditSpecification worker) Save indication that the specified worker has had at least one event dispatched to it during the processing of the current batch.
void	redispatchEvent(LibrarySession session, AuditEvent event, DispatchedEvent de) Re-Dispatch a single event from a batch that selected, forthe case where the event was requeued..
protected void	refreshDispatchedEventList(LibrarySession session) Refresh the list of dispatched events.
protected void	refreshDispatchingPolicy(LibrarySession session) Refresh the dispatching policy.

Methods inherited from class java.lang.Object

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

Field Detail

SETTING_CONTINUOUS_WORKER_ENABLED

public static final String SETTING_CONTINUOUS_WORKER_ENABLED

DispatchingHandlerSpecification setting that indicates whether the same Worker should be used for processing events for the same effective target object referenced in the AuditEvent - also known as "Continuous Worker" mode. (a Boolean).

See Also:

Constant Field Values

SETTING_NAME_DISPATCHING_POLICY

public static final String SETTING_NAME_DISPATCHING_POLICY

DispatchingHandlerSpecification setting that specifies the dispatching policy. (a String).

See Also:

Constant Field Values

SETTING_NAME_DISPATCHING_POLICY_FAST_LANE_COUNT

public static final String SETTING_NAME_DISPATCHING_POLICY_FAST_LANE_COUNT

DispatchingHandlerSpecification setting that specifies the the number of "Fast Lanes" to use for certain dispatching policies. (an Integer).

See Also:

Constant Field Values

DE_SETTING_EFFECTIVE_TARGETOBJECT

public static final String DE_SETTING_EFFECTIVE_TARGETOBJECT

DispatchedEvent setting that holds the effective target object of the event. (a LibraryObject).

See Also:

Constant Field Values

DISPATCHING_POLICY_ROUNDROBIN

public static final String DISPATCHING_POLICY_ROUNDROBIN

Dispatching policy for simple round robin.

See Also:

Constant Field Values

DISPATCHING_POLICY_LEASTLOADED

public static final String DISPATCHING_POLICY_LEASTLOADED

Dispatching policy for choosing the handler that is least loaded from a processing cost perspective.

See Also:

Constant Field Values

DISPATCHING_POLICY_LEAST_LOADED_FASTLANE

public static final String DISPATCHING_POLICY_LEAST_LOADED_FASTLANE

The dispatching Policy name used for a "least loaded" dispatching strategy where the first N Workers are used as a fast lane as compared to the other Workers.

See Also:

Constant Field Values

SETTING_NAME_DISPATCHING_POLICY_DEFAULT

public static final String SETTING_NAME_DISPATCHING_POLICY_DEFAULT

Default policy if not specified in the DispatchingHandlerSpecification.

See Also:

Constant Field Values

Constructor Detail

DispatchingHandlerState

public DispatchingHandlerState()

Constructs a DispatchingHandlerState.

Method Detail

initialize

public void initialize(DispatchingHandler handler,
                       AuditSpecification dispatcher,
                       DispatchingHandlerSpecification dhSpec)
                throws IfsException

Initializes a newly constructed DispatchingHandlerState instance.

Parameters:

handler - the DispatchingHandler

dispatcher - the AuditSpecification for the dispatching handler

dhSpec - the DispatchingHandlerSpecification used by the dispatching handler

Throws:

IfsException - if the operation fails.

constructWorkerState

protected DispatchingHandlerState.WorkerState constructWorkerState(AuditSpecification worker)
                                                            throws IfsException

Constructs a WorkerState.

Can be overridden by subclasses to construct a custom subclass of WorkerState.

Parameters:

worker - the Worker

Returns:

a newly constructed WorkerState instance

Throws:

IfsException - if the opertation fails

getWorkerState

protected DispatchingHandlerState.WorkerState getWorkerState(AuditSpecification worker)
                                                      throws IfsException

Get a WorkerState for the specified Worker's AuditSpecification.

Parameters:

worker - the Worker

Returns:

the corresponding WorkerState

Throws:

IfsException - if the opertation fails

refreshDispatchingPolicy

protected void refreshDispatchingPolicy(LibrarySession session)
                                 throws IfsException

Refresh the dispatching policy.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

canDispatch

public boolean canDispatch()
                    throws IfsException

Gets whether the state reflects the ability to dispatch new events.

Returns:

true if able to dispatch new events; false otherwise

Throws:

IfsException - if the operation fails

getDispatchingHandler

public DispatchingHandler getDispatchingHandler()
                                         throws IfsException

Gets the DispatchingHandler.

Returns:

the DispatchingHandler

Throws:

IfsException - if the operation fails.

getDispatchingAuditSpecification

public AuditSpecification getDispatchingAuditSpecification(LibrarySession session)
                                                    throws IfsException

Gets the Dispatching AuditSpecification.

Parameters:

session - the session context

Returns:

the Dispatching AuditSpecification

Throws:

IfsException - if the operation fails.

getDispatchingHandlerSpecification

public DispatchingHandlerSpecification getDispatchingHandlerSpecification(LibrarySession session)
                                                                   throws IfsException

Gets the DispatchingHandlerSpecification.

Parameters:

session - the session context

Returns:

the DispatchingHandlerSpecification

Throws:

IfsException - if the operation fails.

getAllWorkers

public AuditSpecification[] getAllWorkers(LibrarySession session)
                                   throws IfsException

Gets the complete set of Workers defined.

Parameters:

session - the session context

Returns:

the complete set of Workers

Throws:

IfsException - if the operation fails

getActiveWorkers

public AuditSpecification[] getActiveWorkers(LibrarySession session)
                                      throws IfsException

Gets the set of active Workers defined.

This refers to the Workers that can receive new Dispatched events, effectively the "active working AuditSpecifications". Note that the actual handlers may be active when the parent AuditSpecification is not active, in order to drain the queue.

Parameters:

session - the session context

Returns:

the set of active Workers

Throws:

IfsException - if the operation fails

getWorkerStateMap

public Map<Long,DispatchingHandlerState.WorkerState> getWorkerStateMap()
                                                                throws IfsException

Gets the map that holds Worker state, keyed by the worker's AuditSpecification ID.

Returns:

the map of Worker state info

Throws:

IfsException - if the operation fails

getDispatchingPolicy

public String getDispatchingPolicy()
                            throws IfsException

Gets the dispatching policy in effect.

Values supported intrinsically are: "RoundRobin", "LeastLoaded", and "LeastLoaded_FastLane". Subclasses can extend and add custom policies.

Returns:

the dispatching policy

Throws:

IfsException - if the operation fails

isContinuousWorkerEnabled

public boolean isContinuousWorkerEnabled()
                                  throws IfsException

Gets indication as to whether the same Worker should be used for processing events for the same effective target object referenced in the AuditEvent - also known as "Continuous Worker" mode.

Returns:

true iff in Continuous Worker mode.

Throws:

IfsException - if the operation fails

getMaximumWorkerQueueSize

public int getMaximumWorkerQueueSize()
                              throws IfsException

Gets the maximum size of a Worker's event queue.

A value of 0 implies no maximum.

Returns:

the maximum size of a Worker's event queue

Throws:

IfsException - if the operation fails

handleTimerExpired

public void handleTimerExpired(LibrarySession session)
                        throws IfsException

Handle tasks to be performed at the dispatcher's timer interval.

Parameters:

session - the session state

Throws:

IfsException - if the operation fails.

checkActiveWorkers

protected void checkActiveWorkers(LibrarySession session)
                           throws IfsException

Checks to see if there are any changes to Active workers.

Parameters:

session - the session state

Throws:

IfsException - if the operation fails.

checkInactiveWorkers

protected void checkInactiveWorkers(LibrarySession session)
                             throws IfsException

Checks to see if any Inactive workers should have their handler deactivated.

Parameters:

session - the session state

Throws:

IfsException - if the operation fails.

dispatchEvent

public void dispatchEvent(LibrarySession session,
                          AuditEvent event)
                   throws IfsException

Dispatch a single event from a batch that selected.

Parameters:

session - the session state

event - the event to dispatch

Throws:

IfsException - if the operation fails.

redispatchEvent

public void redispatchEvent(LibrarySession session,
                            AuditEvent event,
                            DispatchedEvent de)
                     throws IfsException

Re-Dispatch a single event from a batch that selected, forthe case where the event was requeued..

Parameters:

session - the session state

event - the event to dispatch

de - the existing DispatchedEvent

Throws:

IfsException - if the operation fails.

markDispatchedWorker

protected void markDispatchedWorker(AuditSpecification worker)
                             throws IfsException

Save indication that the specified worker has had at least one event dispatched to it during the processing of the current batch.

Parameters:

worker - the Worker that has been dispatched to

Throws:

IfsException - if the operation fails

determineWorker

protected AuditSpecification determineWorker(LibrarySession session,
                                             AuditEvent event,
                                             AttributeValueTable deTable)
                                      throws IfsException

Determine the Worker to use for the next AuditEvent.

Parameters:

session - the session context

event - the AuditEvent that is being considered for dispatch

deTable - the DispatchedEvent settings table

Returns:

the Worker that should receive the next event

Throws:

IfsException - if the operation fails

getActiveWorkerForNextEvent

protected AuditSpecification getActiveWorkerForNextEvent(LibrarySession session,
                                                         AuditEvent event,
                                                         AttributeValueTable deTable)
                                                  throws IfsException

Gets the Worker that should receive the next event.

Parameters:

session - the session context

event - the AuditEvent that is being considered for dispatch

deTable - the DispatchedEvent settings table

Returns:

the Worker that should receive the next event

Throws:

IfsException - if the operation fails

initializeDispatchedEventSettings

protected void initializeDispatchedEventSettings(LibrarySession session,
                                                 AuditEvent event,
                                                 AttributeValueTable deTable)
                                          throws IfsException

Initialize any DispatchedEvent settings that will eventually get stored on the newly created (or updated) DispatchedEvent.

Parameters:

session - the session context

event - the AuditEvent that is being considered for dispatch

deTable - the DispatchedEvent settings table

Throws:

IfsException - if the operation fails

finalizeDispatchedEventSettings

protected void finalizeDispatchedEventSettings(LibrarySession session,
                                               AuditEvent event,
                                               AttributeValueTable deTable)
                                        throws IfsException

Finalize any DispatchedEvent settings that will eventually get stored on the newly created (or updated) DispatchedEvent.

Parameters:

session - the session context

event - the AuditEvent that is being dispatched

deTable - the DispatchedEvent settings table

Throws:

IfsException - if the operation fails

applyDispatchedEventSettings

protected void applyDispatchedEventSettings(DispatchedEvent de,
                                            AttributeValueTable deTable)
                                     throws IfsException

Apply any DispatchedEvent settings that are present in the specified settings table.

Parameters:

de - the DispatchedEvent to update

deTable - the DispatchedEvent settings table

Throws:

IfsException - if the operation fails

getEffectiveTargetObjectIdForEvent

protected Long getEffectiveTargetObjectIdForEvent(LibrarySession session,
                                                  AuditEvent event)
                                           throws IfsException

Get the effective target object ID for the specified event, used when "ContinuousWorkerEnabled" is enabled.

Parameters:

session - the session context

deTable - the DispatchedEvent settings table

Returns:

the effective target object

Throws:

IfsException - if the operation fails

getEffectiveTargetObjectForEvent

protected LibraryObject getEffectiveTargetObjectForEvent(LibrarySession session,
                                                         AuditEvent event)
                                                  throws IfsException

Get the effective target object for the specified event, used when "ContinuousWorkerEnabled" is enabled.

Parameters:

session - the session context

deTable - the DispatchedEvent settings table

Returns:

the effective target object

Throws:

IfsException - if the operation fails

getActiveWorkerForNextEventRoundRobin

protected AuditSpecification getActiveWorkerForNextEventRoundRobin(LibrarySession session)
                                                            throws IfsException

Gets the Worker that should receive the next event, using "round robin" policy.

Parameters:

session - the session context

Returns:

the Worker that should receive the next event

Throws:

IfsException - if the operation fails

getActiveWorkerForNextEventLeastLoaded

protected AuditSpecification getActiveWorkerForNextEventLeastLoaded(LibrarySession session)
                                                             throws IfsException

Gets the Workers that should receive the next event, using "least loaded worker" policy.

Parameters:

session - the session context

Returns:

the Worker that should receive the next event

Throws:

IfsException - if the operation fails

getActiveWorkerForNextEventLeastLoaded

protected AuditSpecification getActiveWorkerForNextEventLeastLoaded(LibrarySession session,
                                                                    AuditSpecification[] workers)
                                                             throws IfsException

Gets the Worker that should receive the next event, using "least loaded worker" policy, using the specified set of Workers as possible candidates.

Parameters:

session - the session context

workers - the Worker pool to use

Returns:

the Worker that should receive the next event

Throws:

IfsException - if the operation fails

getLeastLoadedWorker

protected AuditSpecification getLeastLoadedWorker(LibrarySession session,
                                                  AuditSpecification[] workers)
                                           throws IfsException

Gets the Worker that currently is least loaded, using the specified set of Workers as possible candidates.

Parameters:

session - the session context

workers - the Worker pool to use

Returns:

the least loaded Worker

Throws:

IfsException - if the operation fails.

getLeastLoadedWorkerWithFastLane

protected AuditSpecification getLeastLoadedWorkerWithFastLane(LibrarySession session,
                                                              AuditEvent event,
                                                              int fastlaneCount)
                                                       throws IfsException

Gets the Worker that should receive the next event, using "least loaded worker" policy, taking into account the number of "Fast Lanes" specified..

Parameters:

session - the session context

event - the event to be dispatched

fastlaneCount - how many Workers are reserved for "fast lane"

Returns:

the Worker that should receive the next event

Throws:

IfsException - if the operation fails

isFastLaneEvent

protected boolean isFastLaneEvent(LibrarySession session,
                                  AuditEvent event)
                           throws IfsException

Checks the specified event to see if it should be considered a "fast lane" event.

Parameters:

session - the session context

event - the event to be dispatched

Returns:

true iff the event is a "fast lane" event

Throws:

IfsException - if the operation fails

beginEventBatch

public void beginEventBatch(LibrarySession session)
                     throws IfsException

Mark the beginning of processing a batch of events.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

endEventBatch

public void endEventBatch(LibrarySession session)
                   throws IfsException

Mark the end of processing a batch of events.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

alertHandlers

protected void alertHandlers(LibrarySession session)
                      throws IfsException

Notify any handlers that we dispatched to

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

addDispatchedEvent

protected void addDispatchedEvent(DispatchedEvent de)
                           throws IfsException

Adds a new DispatchedEvent to the Worker and to the list of DispatchedEvents issued by the dispatcher.

Parameters:

de - the DispatchedEvent

Throws:

IfsException - if the operation fails.

addDispatchedEvent

protected void addDispatchedEvent(DispatchedEvent de,
                                  boolean addToList)
                           throws IfsException

Adds a new DispatchedEvent to the Worker and conditionally to the list of DispatchedEvents issued by the dispatcher.

Parameters:

de - the DispatchedEvent

addToList - whether to add the event to the list

Throws:

IfsException - if the operation fails.

refreshDispatchedEventList

protected void refreshDispatchedEventList(LibrarySession session)
                                   throws IfsException

Refresh the list of dispatched events.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails.

getDispatchedEvents

public DispatchedEvent[] getDispatchedEvents(LibrarySession session)
                                      throws IfsException

Gets the array of dispatched events.

Parameters:

session - the session context

Returns:

the set of dispatched events

Throws:

IfsException - if the operation fails.

addToEffectiveTargetObjectMap

protected void addToEffectiveTargetObjectMap(DispatchedEvent de)
                                      throws IfsException

Adds a DispatchedEvent to the "ContinuousWorkerEnabled" map if that option is enabled.

Parameters:

de - the DispatchedEvent

Throws:

IfsException - if the operation fails.