oracle.ifs.core.beans

Class DispatchedEvent

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.core.beans.DispatchedEvent

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieDispatchedEvent

public class DispatchedEvent
extends TieSimpleObject

A DispatchedEvent encapsulates an AuditEvent whose processing is managed by a DispatchingHandler.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DispatchedEvent.StatusCode Enumeration for the various status codes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUDITEVENT_PROPERTYNAME_ESTIMATEDCOST The AuditEvent property key for estimated cost of processing an AuditEvent that will be dispatched to Workers.
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	CONFIRMEDCOST_ATTRIBUTE The name of the Attribute representing the confirmed cost (relative to 1) of processing this event, set by the Worker.
static String	CREATEDATE_ATTRIBUTE The name of the Attribute representing The date this DispatchedEvent was created.
static String	DISPATCHINGAUDITSPECIFICATION_ATTRIBUTE The name of the Attribute representing the dispatcher's AuditSpecification.
static String	DISPATCHINGHANDLERSPECIFICATION_ATTRIBUTE The name of the Attribute representing the DispatchingHandlerSpecification used to dispatch the event.
static String	ESTIMATEDCOST_ATTRIBUTE The name of the Attribute representing the estimated cost (relative to 1) of processing this event, set by the dispatcher.
static String	EVENTID_ATTRIBUTE The name of the Attribute representing The AuditEvent ID.
static String	EVENTSETNAME_ATTRIBUTE The name of the Attribute representing the name of the Event Set that this event is a member of.
static String	SETTING_DEPENDENT_DISPATCHEDEVENT_ID DispatchedEvent setting that holds the dependent DispatchedEvent ID of the event.
static String	SETTING_EFFECTIVE_TARGETOBJECT DispatchedEvent setting that holds the effective target object of the event.
static String	SETTING_RETRY_ON_FAILURE_PHASE DispatchedEvent setting that holds the RetryOnFailure rety phase number.
static String	SETTING_RETRY_ON_FAILURE_TIME DispatchedEvent setting that holds the time (in milliseconds since 1970) when the next retry phase should be attempted.
static String	SETTINGS_ATTRIBUTE The name of the Attribute representing the settings that can be used for custom communication between the dispatcher and a Worker.
static String	STATUSCODE_ATTRIBUTE The name of the Attribute representing The code that identifies the status of the DispatchedEvent.
static int	STATUSCODE_NUMBER_CREATED The DispatchedEvent status code indicating that the event associated with the object has been created but not yet dispatched.
static int	STATUSCODE_NUMBER_DISPATCHED The DispatchedEvent status code indicating that the event associated with the object has been dispatched, but processing has not yet begun.
static int	STATUSCODE_NUMBER_PROCESSING_COMPLETED The DispatchedEvent status code indicating that the event associated with the object has been dispatched, and that processing has been completed.
static int	STATUSCODE_NUMBER_PROCESSING_STARTED The DispatchedEvent status code indicating that the event associated with the object has been dispatched, and that processing has started.
static int	STATUSCODE_NUMBER_REQUEUED The DispatchedEvent status code indicating that the event associated with the object has been requeued manually by the Worker back to the dispatcher.
static String	UUID_ATTRIBUTE The name of the Attribute representing the UUID.
static String	WORKINGAUDITSPECIFICATION_ATTRIBUTE The name of the Attribute representing the Worker's AuditSpecification.

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, NAME_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DispatchedEvent(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a DispatchedEvent object.

Method Summary

Modifier and Type	Method and Description
void	addSetting(String key, AttributeValue value) Adds a setting (SimpleProperty) for this object.
static DispatchedEvent	create(AuditEvent event, DispatchingHandlerSpecification dhSpec, AuditSpecification dispatcher, AuditSpecification worker, String eventSetName, Integer estCost) Creates an new DispatchedEvent for the specified event.
static DispatchedEvent[]	findAllByDispatcher(AuditSpecification spec) Returns all DispatchedEvents for a dispatcher.
static DispatchedEvent[]	findAllByDispatchingHandlerSpecification(DispatchingHandlerSpecification spec) Returns all DispatchedEvents for DispatchingHandlerSpecification.
static DispatchedEvent[]	findAllByWorker(AuditSpecification spec) Returns all DispatchedEvents for a Worker.
static DispatchedEvent	findByEventId(LibrarySession session, long eventId) Returns the DispatchedEvent for the specified event ID.
Integer	getConfirmedCost() Gets the confirmed cost (relative to 1) of processing this event, set by the Worker, or null if undefined.
int	getCost() Gets the cost, retuning either the confirmed cost (if available) or the estimated cost.
Long	getDependentDispatchedEventId() Gets the ID of the DE that this instance is dependent upon, due to a previous failure of the dependent DE.
AuditSpecification	getDispatchingAuditSpecification() Returns the dispatcher's AuditSpecification.
DispatchingHandlerSpecification	getDispatchingHandlerSpecification() Returns the DispatchingHandlerSpecification used to dispatch the event.
Long	getEffectiveTargetObjectId() Gets the effective target object Id.
int	getEstimatedCost() Gets the estimated cost (relative to 1) of processing this event, set by the dispatcher.
Long	getEventId() Gets The ID of the encapsulated AuditEvent.
String	getEventSetName() Gets the name of the Event Set that this event is a member of.
Date	getRequestDate() Gets the date this DispatchedEvent was created.
int	getRetryPhase() Gets the "RetryOnFailure" retry phase.
Long	getRetryTime() Gets the "RetryOnFailure" retry time.
AttributeValue	getSetting(String key) Gets the setting that can be used for custom communication between the dispatcher and a Worker.
SimpleProperty[]	getSettings() Gets the settings that can be used for custom communication between the dispatcher and a Worker.
DispatchedEvent.StatusCode	getStatusCode() Gets the status code enum.
String	getStatusCodeName() Gets the status code name.
int	getStatusCodeNumber() Gets the status code number.
String	getUuid() Gets the value of the UUID attribute.
AuditSpecification	getWorkingAuditSpecification() Returns the Worker's AuditSpecification.
static String	lookupStatusCodeName(int codeNum) Get the Status code name that corresponds to the specified Status code number.
static Integer	lookupStatusCodeNumber(String codeName) Get the Status code number that corresponds to the specified Status code name.
void	removeDependentDispatchedEventId() Removes the "dependent DispatchedEvent ID" setting.
void	removeRetryTime() Removes the "RetryOnFailure" retry time.
void	removeSetting(String key) Removes a setting (SimpleProperty) for this object.
void	requeueToDispatcher(AuditEvent event) Requeue the specified event back to the dispatcher.
void	requeueToDispatcher(AuditEvent event, DispatchedEvent.StatusCode status) Requeue the specified event back to the dispatcher.
void	setCreated() Set the StatusCode to "Created".
void	setDependentDispatchedEventId(Long dependentId) Sets the ID of the DE that this instance is dependent upon, due to a previous failure of the dependent DE.
void	setDispatched() Set the StatusCode to "Dispatched".
void	setEffectiveTargetObjectId(Long targetId) Sets the effective target object Id.
void	setProcessingCompleted() Set the StatusCode to "Processing Completed".
void	setProcessingStarted() Set the StatusCode to "Processing Started".
void	setRetryPhase(int retryPhase) Sets the "RetryOnFailure" retry phase.
void	setRetryTime(long retryTime) Sets the "RetryOnFailure" retry time.
void	setStatusCode(DispatchedEvent.StatusCode sc) Sets a new extraction state.
void	setStatusCode(int scNum) Sets a new status code.
void	update(AuditSpecification worker, String eventSetName, Integer estCost) Updates a DispatchedEvent.

Methods inherited from class oracle.ifs.beans.SimpleObject

free, handleCreate, isValidEventType

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, hasNameAttribute, hasPropertyBundleAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postCreate, postEvent, postEvent, postFree, postUpdate, preCreate, preFree, prePostAuditEvent, preUpdate, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

UUID_ATTRIBUTE

public static final String UUID_ATTRIBUTE

The name of the Attribute representing the UUID.

See Also:

Constant Field Values

EVENTID_ATTRIBUTE

public static final String EVENTID_ATTRIBUTE

The name of the Attribute representing The AuditEvent ID.

See Also:

Constant Field Values

STATUSCODE_ATTRIBUTE

public static final String STATUSCODE_ATTRIBUTE

The name of the Attribute representing The code that identifies the status of the DispatchedEvent.

See Also:

Constant Field Values

CREATEDATE_ATTRIBUTE

public static final String CREATEDATE_ATTRIBUTE

The name of the Attribute representing The date this DispatchedEvent was created.

See Also:

Constant Field Values

DISPATCHINGHANDLERSPECIFICATION_ATTRIBUTE

public static final String DISPATCHINGHANDLERSPECIFICATION_ATTRIBUTE

The name of the Attribute representing the DispatchingHandlerSpecification used to dispatch the event.

See Also:

Constant Field Values

DISPATCHINGAUDITSPECIFICATION_ATTRIBUTE

public static final String DISPATCHINGAUDITSPECIFICATION_ATTRIBUTE

The name of the Attribute representing the dispatcher's AuditSpecification.

See Also:

Constant Field Values

WORKINGAUDITSPECIFICATION_ATTRIBUTE

public static final String WORKINGAUDITSPECIFICATION_ATTRIBUTE

The name of the Attribute representing the Worker's AuditSpecification.

See Also:

Constant Field Values

ESTIMATEDCOST_ATTRIBUTE

public static final String ESTIMATEDCOST_ATTRIBUTE

The name of the Attribute representing the estimated cost (relative to 1) of processing this event, set by the dispatcher.

See Also:

Constant Field Values

CONFIRMEDCOST_ATTRIBUTE

public static final String CONFIRMEDCOST_ATTRIBUTE

The name of the Attribute representing the confirmed cost (relative to 1) of processing this event, set by the Worker.

See Also:

Constant Field Values

EVENTSETNAME_ATTRIBUTE

public static final String EVENTSETNAME_ATTRIBUTE

The name of the Attribute representing the name of the Event Set that this event is a member of.

See Also:

Constant Field Values

SETTINGS_ATTRIBUTE

public static final String SETTINGS_ATTRIBUTE

The name of the Attribute representing the settings that can be used for custom communication between the dispatcher and a Worker. (SimpleProperty[])

See Also:

Constant Field Values

STATUSCODE_NUMBER_CREATED

public static final int STATUSCODE_NUMBER_CREATED

The DispatchedEvent status code indicating that the event associated with the object has been created but not yet dispatched.

See Also:

Constant Field Values

(Published)

STATUSCODE_NUMBER_DISPATCHED

public static final int STATUSCODE_NUMBER_DISPATCHED

The DispatchedEvent status code indicating that the event associated with the object has been dispatched, but processing has not yet begun.

See Also:

Constant Field Values

(Published)

STATUSCODE_NUMBER_PROCESSING_STARTED

public static final int STATUSCODE_NUMBER_PROCESSING_STARTED

The DispatchedEvent status code indicating that the event associated with the object has been dispatched, and that processing has started.

See Also:

Constant Field Values

(Published)

STATUSCODE_NUMBER_PROCESSING_COMPLETED

public static final int STATUSCODE_NUMBER_PROCESSING_COMPLETED

The DispatchedEvent status code indicating that the event associated with the object has been dispatched, and that processing has been completed.

See Also:

Constant Field Values

(Published)

STATUSCODE_NUMBER_REQUEUED

public static final int STATUSCODE_NUMBER_REQUEUED

The DispatchedEvent status code indicating that the event associated with the object has been requeued manually by the Worker back to the dispatcher.

See Also:

Constant Field Values

(Published)

SETTING_EFFECTIVE_TARGETOBJECT

public static final String SETTING_EFFECTIVE_TARGETOBJECT

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

See Also:

Constant Field Values

SETTING_RETRY_ON_FAILURE_PHASE

public static final String SETTING_RETRY_ON_FAILURE_PHASE

DispatchedEvent setting that holds the RetryOnFailure rety phase number.

See Also:

Constant Field Values

SETTING_RETRY_ON_FAILURE_TIME

public static final String SETTING_RETRY_ON_FAILURE_TIME

DispatchedEvent setting that holds the time (in milliseconds since 1970) when the next retry phase should be attempted.

See Also:

Constant Field Values

SETTING_DEPENDENT_DISPATCHEDEVENT_ID

public static final String SETTING_DEPENDENT_DISPATCHEDEVENT_ID

DispatchedEvent setting that holds the dependent DispatchedEvent ID of the event. (a Long).

See Also:

Constant Field Values

AUDITEVENT_PROPERTYNAME_ESTIMATEDCOST

public static final String AUDITEVENT_PROPERTYNAME_ESTIMATEDCOST

The AuditEvent property key for estimated cost of processing an AuditEvent that will be dispatched to Workers.

See Also:

Constant Field Values

Constructor Detail

DispatchedEvent

protected DispatchedEvent(LibrarySession session,
                          Long id,
                          Long classId,
                          S_LibraryObjectData data)
                   throws IfsException

Construct a DispatchedEvent object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

getUuid

public String getUuid()
               throws IfsException

Gets the value of the UUID attribute.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getEventId

public Long getEventId()
                throws IfsException

Gets The ID of the encapsulated AuditEvent.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getStatusCodeNumber

public int getStatusCodeNumber()
                        throws IfsException

Gets the status code number.

Returns:

the numeric value of the status code

Throws:

IfsException - if the operation fails

getStatusCode

public DispatchedEvent.StatusCode getStatusCode()
                                         throws IfsException

Gets the status code enum.

Returns:

the status code enum

Throws:

IfsException - if the operation fails

getStatusCodeName

public String getStatusCodeName()
                         throws IfsException

Gets the status code name.

Returns:

the status code name

Throws:

IfsException - if the operation fails

lookupStatusCodeNumber

public static Integer lookupStatusCodeNumber(String codeName)
                                      throws IfsException

Get the Status code number that corresponds to the specified Status code name.

Parameters:

codeName - the Status code name

Returns:

the Status code number

Throws:

IfsException - if the operation fails

lookupStatusCodeName

public static String lookupStatusCodeName(int codeNum)
                                   throws IfsException

Get the Status code name that corresponds to the specified Status code number.

Parameters:

codeNum - the Status code number

Returns:

the Status code name

Throws:

IfsException - if the operation fails

getRequestDate

public Date getRequestDate()
                    throws IfsException

Gets the date this DispatchedEvent was created.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getDispatchingHandlerSpecification

public DispatchingHandlerSpecification getDispatchingHandlerSpecification()
                                                                   throws IfsException

Returns the DispatchingHandlerSpecification used to dispatch the event.

Returns:

the DispatchingHandlerSpecification

Throws:

IfsException - if operation fails

(Published)

getDispatchingAuditSpecification

public AuditSpecification getDispatchingAuditSpecification()
                                                    throws IfsException

Returns the dispatcher's AuditSpecification.

Returns:

the dispatcher's AuditSpecification

Throws:

IfsException - if operation fails

(Published)

getWorkingAuditSpecification

public AuditSpecification getWorkingAuditSpecification()
                                                throws IfsException

Returns the Worker's AuditSpecification.

Returns:

the Worker's AuditSpecification

Throws:

IfsException - if operation fails

(Published)

getEstimatedCost

public int getEstimatedCost()
                     throws IfsException

Gets the estimated cost (relative to 1) of processing this event, set by the dispatcher.

Returns:

the estimated cost

Throws:

IfsException - if the operation fails

getConfirmedCost

public Integer getConfirmedCost()
                         throws IfsException

Gets the confirmed cost (relative to 1) of processing this event, set by the Worker, or null if undefined.

Returns:

the confirmed cost

Throws:

IfsException - if the operation fails

getCost

public int getCost()
            throws IfsException

Gets the cost, retuning either the confirmed cost (if available) or the estimated cost.

Returns:

the cost

Throws:

IfsException - if the operation fails

getEventSetName

public String getEventSetName()
                       throws IfsException

Gets the name of the Event Set that this event is a member of.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getSettings

public SimpleProperty[] getSettings()
                             throws IfsException

Gets the settings that can be used for custom communication between the dispatcher and a Worker.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getSetting

public AttributeValue getSetting(String key)
                          throws IfsException

Gets the setting that can be used for custom communication between the dispatcher and a Worker.

Parameters:

key - the key

Returns:

the setting's value

Throws:

IfsException - if the operation fails

getEffectiveTargetObjectId

public Long getEffectiveTargetObjectId()
                                throws IfsException

Gets the effective target object Id.

Returns null if setting is not set.

Returns:

the effective target object Id

Throws:

IfsException - if the operation fails

getRetryPhase

public int getRetryPhase()
                  throws IfsException

Gets the "RetryOnFailure" retry phase.

Returns 0 if setting is not set.

Returns:

the retry phase

Throws:

IfsException - if the operation fails

getRetryTime

public Long getRetryTime()
                  throws IfsException

Gets the "RetryOnFailure" retry time.

Returns null if setting is not set.

Returns:

the retry time

Throws:

IfsException - if the operation fails

getDependentDispatchedEventId

public Long getDependentDispatchedEventId()
                                   throws IfsException

Gets the ID of the DE that this instance is dependent upon, due to a previous failure of the dependent DE.

Returns null if setting is not set.

Returns:

the dependent DispatchedEvent ID

Throws:

IfsException - if the operation fails

setEffectiveTargetObjectId

public void setEffectiveTargetObjectId(Long targetId)
                                throws IfsException

Sets the effective target object Id.

Parameters:

targetId - the effective target object Id

Throws:

IfsException - if the operation fails

setRetryPhase

public void setRetryPhase(int retryPhase)
                   throws IfsException

Sets the "RetryOnFailure" retry phase.

Parameters:

retryPhase - the retry phase

Throws:

IfsException - if the operation fails

setRetryTime

public void setRetryTime(long retryTime)
                  throws IfsException

Sets the "RetryOnFailure" retry time.

Parameters:

retryTime - the retry time (millis since 1970)

Throws:

IfsException - if the operation fails

setDependentDispatchedEventId

public void setDependentDispatchedEventId(Long dependentId)
                                   throws IfsException

Sets the ID of the DE that this instance is dependent upon, due to a previous failure of the dependent DE.

Parameters:

dependentId - the dependent DE Id

Throws:

IfsException - if the operation fails

removeRetryTime

public void removeRetryTime()
                     throws IfsException

Removes the "RetryOnFailure" retry time.

Throws:

IfsException - if the operation fails

removeDependentDispatchedEventId

public void removeDependentDispatchedEventId()
                                      throws IfsException

Removes the "dependent DispatchedEvent ID" setting.

Throws:

IfsException - if the operation fails

addSetting

public void addSetting(String key,
                       AttributeValue value)
                throws IfsException

Adds a setting (SimpleProperty) for this object.

Parameters:

key - the setting property's key

value - the setting property's value

Throws:

IfsException - if the operation fails

removeSetting

public void removeSetting(String key)
                   throws IfsException

Removes a setting (SimpleProperty) for this object.

Parameters:

key - the setting property's key

Throws:

IfsException - if the operation fails

setStatusCode

public void setStatusCode(int scNum)
                   throws IfsException

Sets a new status code.

Parameters:

scNum - the new StatusCode number

Throws:

IfsException - if operation fails

setStatusCode

public void setStatusCode(DispatchedEvent.StatusCode sc)
                   throws IfsException

Sets a new extraction state.

Parameters:

sc - the new StatusCode

Throws:

IfsException - if operation fails

setCreated

public void setCreated()
                throws IfsException

Set the StatusCode to "Created".

Throws:

IfsException - if operation fails

setDispatched

public void setDispatched()
                   throws IfsException

Set the StatusCode to "Dispatched".

Throws:

IfsException - if operation fails

setProcessingStarted

public void setProcessingStarted()
                          throws IfsException

Set the StatusCode to "Processing Started".

Throws:

IfsException - if operation fails

setProcessingCompleted

public void setProcessingCompleted()
                            throws IfsException

Set the StatusCode to "Processing Completed".

Throws:

IfsException - if operation fails

requeueToDispatcher

public void requeueToDispatcher(AuditEvent event)
                         throws IfsException

Requeue the specified event back to the dispatcher.

Sets the StatusCode to STATUSCODE_REQUEUED.

Parameters:

event - the AuditEvent to requeue

Throws:

IfsException - if operation fails

requeueToDispatcher

public void requeueToDispatcher(AuditEvent event,
                                DispatchedEvent.StatusCode status)
                         throws IfsException

Requeue the specified event back to the dispatcher.

Parameters:

event - the AuditEvent to requeue

status - the Status code this event is updated to

Throws:

IfsException - if operation fails

create

public static DispatchedEvent create(AuditEvent event,
                                     DispatchingHandlerSpecification dhSpec,
                                     AuditSpecification dispatcher,
                                     AuditSpecification worker,
                                     String eventSetName,
                                     Integer estCost)
                              throws IfsException

Creates an new DispatchedEvent for the specified event.

Parameters:

event - The event that is being dispatched

dhSpec - The DispatchingHandlerSpecification

dispatcher - The dispatcher

worker - The Worker to dispatch to

eventSetName - The Event Set name, or null if event is not in a set

estCost - The estimated cost to process event (relative to 1)

Returns:

the newly created instance

Throws:

IfsException - if the operation fails

update

public void update(AuditSpecification worker,
                   String eventSetName,
                   Integer estCost)
            throws IfsException

Updates a DispatchedEvent.

This happens when an event gets requeued back to the dispatcher, who then re-dispatches to another Worker. It is also called during a rebalance operation to queue events back to the dispatcher.

Parameters:

worker - The Worker to dispatch to

eventSetName - The Event Set name (if null, do not update)

estCost - The estimated cost (if null, do not update)

Throws:

IfsException - if the operation fails

findAllByDispatchingHandlerSpecification

public static DispatchedEvent[] findAllByDispatchingHandlerSpecification(DispatchingHandlerSpecification spec)
                                                                  throws IfsException

Returns all DispatchedEvents for DispatchingHandlerSpecification.

The instances will be sorted by ID.

Parameters:

spec - the DispatchingHandlerSpecification

Returns:

the set of DispatchedEvents

Throws:

IfsException - if the operation fails.

findAllByDispatcher

public static DispatchedEvent[] findAllByDispatcher(AuditSpecification spec)
                                             throws IfsException

Returns all DispatchedEvents for a dispatcher.

The instances will be sorted by ID.

Parameters:

spec - the AuditSpecification for the dispatcher

Returns:

the set of DispatchedEvents

Throws:

IfsException - if the operation fails.

findAllByWorker

public static DispatchedEvent[] findAllByWorker(AuditSpecification spec)
                                         throws IfsException

Returns all DispatchedEvents for a Worker.

The instances will be sorted by ID.

Parameters:

spec - the AuditSpecification for the Worker

Returns:

the set of DispatchedEvents

Throws:

IfsException - if the operation fails.

findByEventId

public static DispatchedEvent findByEventId(LibrarySession session,
                                            long eventId)
                                     throws IfsException

Returns the DispatchedEvent for the specified event ID.

Parameters:

session - the session context

eventId - the event ID

Returns:

the DispatchedEvent matching the specified event ID; or null if it does not exist

Throws:

IfsException - if the operation fails.