com.broadleafcommerce.jobsevents.dao

Interface DatabaseSystemEventDao

All Known Implementing Classes:

DatabaseSystemEventDaoImpl

public interface DatabaseSystemEventDao

Provides persistence operations for jobs and events

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
ProcessedEvent	addFinishedNode(Long eventId, String nodeId) Add a completion marker that signifies a node has completed an event.
void	clear() Perform an EntityManager.clear()
RegisteredNode	createNewNode(String nodeId, String ipAddress, EventWorkerType workerType)
void	delete(MasterScheduledJobNode node)
void	deleteExecutedSingleUseJobs(org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil) Delete non-recurring jobs.
void	deleteJob(Long jobId) Remove job based on the provided job id.
void	deleteOldEvents(org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil) Delete events from the system that are considered complete.
void	deleteOldNodes(Date thresholdDate) Remove nodes from the system that have not participated in a heartbeat check since the threshold date.
SystemEvent	disableEvent(SystemEvent systemEvent) Disable an event so that it will not be processed.
void	disableScheduledJob(Long jobId)
void	enableEventsForProcess(Long processStatusMarker) Mass enable all events based on a marker.
RegisteredNode	find(String nodeId)
List<RegisteredNode>	findActiveNodes(Date thresholdDate) Find all nodes that have a heart beat status newer than the threshold.
ScheduledJob	findJob(Long id)
MasterScheduledJobNode	findMasterDeployNode()
MasterScheduledJobNode	findMasterNode()
SystemEvent	findSystemEvent(Long eventId)
SystemEventDetail	findSystemEventDetailByNameAndValueAndEventType(String eventDetailsName, String eventDetailValue, String eventType)
SystemEvent	finishEventInUseState(SystemEvent systemEvent) Mark a VM scoped event as being finished with processing by a node.
List<SystemEvent>	getLatestDurableEvents(Date lowDate, Date lastProcessedDate, List<Long> alreadyProcessedOnDate, List<Long> toRetry, int startPos, int pageSize, EventWorkerType workerType) Retrieve events of type DURABLE_GLOBAL.
Long	getLatestDurableEventsCount(Date lowDate, Date lastProcessedDate, List<Long> alreadyProcessedOnDate, List<Long> toRetry, EventWorkerType workerType)
List<SystemEvent>	getLatestEvents(Date lowDate, int startPos, int pageSize, EventWorkerType workerType, List<Long> excludeIds) Get the list of EventScopeType.VM events that were created after the lowDate that have not already been executed by this node.
Long	getLatestEventsCount(Date lowDate, EventWorkerType workerType)
List<SystemEvent>	getLatestGlobalEvents(Date lowDate, int startPos, int pageSize, EventWorkerType workerType, String nodeId, List<Long> excludeIds) Get the list of EventScopeType.GLOBAL events that were created after the lowDate that have not already been executed by this node.
List<SystemEvent>	getLatestPriorityEvents(Date lowDate, int startPos, int pageSize, EventWorkerType workerType, String nodeId, List<Long> excludeIds) Get the list of priority events that were created after the lowDate that have not already been executed by this node.
List<SystemEvent>	getLatestScheduledDeployEvents(int startPos, int pageSize)
Date	getMaxEventDateForNode(EventWorkerType workerType, String nodeId) Find the latest date of event that has been completed by this node.
Date	getNodeTimestamp(String nodeId)
boolean	lockGlobalEvent(SystemEvent systemEvent, Long nodeId) Deprecated. No longer used internally
boolean	lockSerialEvent(SystemEvent systemEvent) Lock the event of type SystemEvent.getType().
void	markJobAsExecuted(Long scheduledJobId)
boolean	nodeExists(String nodeId) Determine if a node registration exists in the database for the given id.
boolean	optimisticUnlockSerialEvent(String key) Unlock a serial event using optimistic locking.
void	purgeDerelictMasterDeployNode(Date updated)
void	purgeDerelictMasterNode(Date updated) Remove the master node registration from the database if the time provided is less than the current time.
List<ScheduledJob>	readNewScheduledJobs()
List<ScheduledJob>	readScheduledJobs()
RegisteredNode	refresh(RegisteredNode node)
void	refresh(SystemEvent event)
void	removeLock(SystemEvent systemEvent) Deprecated. No longer used internally
void	save(List<SystemEvent> events)
MasterScheduledJobNode	save(MasterScheduledJobNode node)
RegisteredNode	save(RegisteredNode node)
ScheduledJob	save(ScheduledJob job)
SystemEvent	save(SystemEvent systemEvent)
SystemEvent	startEventInUseState(SystemEvent systemEvent) Mark a VM scoped event as being processed by a node (other node will ignore the event).
void	unlockSerialEvent(String key)
void	updateMasterDeployTimestamp()
void	updateMasterTimestamp()
void	updateMaxEventDate(Date maxEventDate)
void	updateMaxEventDate(String nodeId, Date maxEventDate) Update the time that the node is marked to have completed its last event.
void	updateNodeTimestamp(String nodeId)

Method Detail

save

SystemEvent save(SystemEvent systemEvent)

save

void save(List<SystemEvent> events)

enableEventsForProcess

void enableEventsForProcess(Long processStatusMarker)

Mass enable all events based on a marker. See SystemEvent.getProcessStatusMarker()

Parameters:

processStatusMarker -

nodeExists

boolean nodeExists(String nodeId)

Determine if a node registration exists in the database for the given id.

Parameters:

nodeId -

Returns:

See Also:

RegisteredNode

createNewNode

RegisteredNode createNewNode(String nodeId,
                             String ipAddress,
                             EventWorkerType workerType)

save

RegisteredNode save(RegisteredNode node)

find

RegisteredNode find(String nodeId)

getLatestEvents

List<SystemEvent> getLatestEvents(Date lowDate,
                                  int startPos,
                                  int pageSize,
                                  EventWorkerType workerType,
                                  List<Long> excludeIds)

Get the list of EventScopeType.VM events that were created after the lowDate that have not already been executed by this node. Also, do this in a paged fashion.

Parameters:

lowDate - - deprecated (no longer used in query)

startPos -

pageSize -

workerType -

excludeIds -

Returns:

getLatestGlobalEvents

List<SystemEvent> getLatestGlobalEvents(Date lowDate,
                                        int startPos,
                                        int pageSize,
                                        EventWorkerType workerType,
                                        String nodeId,
                                        List<Long> excludeIds)

Get the list of EventScopeType.GLOBAL events that were created after the lowDate that have not already been executed by this node. Also, do this in a paged fashion. This does not include events of type DURABLE_GLOBAL. See getLatestDurableEvents(java.util.Date, java.util.Date, java.util.List, java.util.List, int, int, com.broadleafcommerce.jobsevents.service.type.EventWorkerType) for retrieving durable events.

Parameters:

lowDate -

startPos -

pageSize -

workerType -

nodeId -

excludeIds -

Returns:

getLatestPriorityEvents

List<SystemEvent> getLatestPriorityEvents(Date lowDate,
                                          int startPos,
                                          int pageSize,
                                          EventWorkerType workerType,
                                          String nodeId,
                                          List<Long> excludeIds)

Get the list of priority events that were created after the lowDate that have not already been executed by this node. Also, do this in a paged fashion. This does not include events of type DURABLE_GLOBAL. See PriorityConsumeWorkerImpl for additional discussion on priority events.

Parameters:

lowDate -

startPos -

pageSize -

workerType -

nodeId -

excludeIds -

Returns:

getLatestScheduledDeployEvents

List<SystemEvent> getLatestScheduledDeployEvents(int startPos,
                                                 int pageSize)

getLatestDurableEvents

List<SystemEvent> getLatestDurableEvents(Date lowDate,
                                         Date lastProcessedDate,
                                         List<Long> alreadyProcessedOnDate,
                                         List<Long> toRetry,
                                         int startPos,
                                         int pageSize,
                                         EventWorkerType workerType)

Retrieve events of type DURABLE_GLOBAL. This will be all events that were created after the lowDate and on or after the lastProcessedDate. Also, since it's possible for multiple events to have the same creation timestamp, we must exclude any events that have already been executed on the lastProcessedDate. The lastProcessedDate and alreadyProcessedOnDate information come from DurableEventStatusInfo, which is harvested from a local store maintained by DurableEventStatusService.

Parameters:

lowDate -

lastProcessedDate -

alreadyProcessedOnDate -

startPos -

pageSize -

workerType -

Returns:

getLatestDurableEventsCount

Long getLatestDurableEventsCount(Date lowDate,
                                 Date lastProcessedDate,
                                 List<Long> alreadyProcessedOnDate,
                                 List<Long> toRetry,
                                 EventWorkerType workerType)

getLatestEventsCount

Long getLatestEventsCount(Date lowDate,
                          EventWorkerType workerType)

disableEvent

SystemEvent disableEvent(SystemEvent systemEvent)

Disable an event so that it will not be processed.

Parameters:

systemEvent -

Returns:

startEventInUseState

SystemEvent startEventInUseState(SystemEvent systemEvent)

Mark a VM scoped event as being processed by a node (other node will ignore the event). Primarily utilized by the EventLockUtil class.

Parameters:

systemEvent - event with scope type of VM

Returns:

finishEventInUseState

SystemEvent finishEventInUseState(SystemEvent systemEvent)

Mark a VM scoped event as being finished with processing by a node. This frees the event up for deletion. Primarily utilized by the EventLockUtil class.

Parameters:

systemEvent - event with scope type of VM

Returns:

deleteOldNodes

void deleteOldNodes(Date thresholdDate)

Remove nodes from the system that have not participated in a heartbeat check since the threshold date.

Parameters:

thresholdDate -

findActiveNodes

List<RegisteredNode> findActiveNodes(Date thresholdDate)

Find all nodes that have a heart beat status newer than the threshold. This returns all nodes, incognito or standard.

Parameters:

thresholdDate -

Returns:

deleteOldEvents

void deleteOldEvents(org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil)

Delete events from the system that are considered complete. For VM events, an event qualifies for deletion simply after it has been executed by a single node. For GLOBAL events, all registered nodes whose creation date is earlier than than the creation date of the event must acknowledge completion before the event can be deleted. GLOBAL_DURABLE events are never deleted.

Parameters:

transUtil -

findMasterNode

MasterScheduledJobNode findMasterNode()

findMasterDeployNode

MasterScheduledJobNode findMasterDeployNode()

save

MasterScheduledJobNode save(MasterScheduledJobNode node)

purgeDerelictMasterNode

void purgeDerelictMasterNode(Date updated)

Remove the master node registration from the database if the time provided is less than the current time.

Parameters:

updated -

purgeDerelictMasterDeployNode

void purgeDerelictMasterDeployNode(Date updated)

readScheduledJobs

List<ScheduledJob> readScheduledJobs()

readNewScheduledJobs

List<ScheduledJob> readNewScheduledJobs()

delete

void delete(MasterScheduledJobNode node)

updateMaxEventDate

void updateMaxEventDate(String nodeId,
                        Date maxEventDate)

Update the time that the node is marked to have completed its last event.

Parameters:

nodeId -

maxEventDate -

updateMaxEventDate

void updateMaxEventDate(Date maxEventDate)

updateMasterTimestamp

void updateMasterTimestamp()

updateMasterDeployTimestamp

void updateMasterDeployTimestamp()

updateNodeTimestamp

void updateNodeTimestamp(String nodeId)

getNodeTimestamp

Date getNodeTimestamp(String nodeId)

refresh

RegisteredNode refresh(RegisteredNode node)

save

ScheduledJob save(ScheduledJob job)

lockSerialEvent

boolean lockSerialEvent(SystemEvent systemEvent)

Lock the event of type SystemEvent.getType(). No other event of this type will be able to execute on any node in the cluster until this event completes consumption.

Parameters:

systemEvent -

Returns:

lockGlobalEvent

@Deprecated
boolean lockGlobalEvent(SystemEvent systemEvent,
                                    Long nodeId)

Deprecated. No longer used internally

Lock the event on the node. No other thread will be able to execute this event on this node.

Parameters:

systemEvent -

nodeId -

Returns:

removeLock

@Deprecated
void removeLock(SystemEvent systemEvent)

Deprecated. No longer used internally

Purge the lock record from the database

Parameters:

systemEvent -

unlockSerialEvent

void unlockSerialEvent(String key)

optimisticUnlockSerialEvent

boolean optimisticUnlockSerialEvent(String key)

Unlock a serial event using optimistic locking. Will throw an OptimisticLockException if the state is already changed by another process.

Parameters:

key -

Returns:

markJobAsExecuted

void markJobAsExecuted(Long scheduledJobId)

deleteExecutedSingleUseJobs

void deleteExecutedSingleUseJobs(org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil)

Delete non-recurring jobs. See ScheduledJob.getTargetDate()

Parameters:

transUtil -

disableScheduledJob

void disableScheduledJob(Long jobId)

clear

void clear()

Perform an EntityManager.clear()

findJob

ScheduledJob findJob(Long id)

deleteJob

void deleteJob(Long jobId)

Remove job based on the provided job id.

Parameters:

jobId -

getMaxEventDateForNode

Date getMaxEventDateForNode(EventWorkerType workerType,
                            String nodeId)

Find the latest date of event that has been completed by this node.

Parameters:

workerType -

nodeId -

Returns:

refresh

void refresh(SystemEvent event)

findSystemEvent

SystemEvent findSystemEvent(Long eventId)

addFinishedNode

ProcessedEvent addFinishedNode(Long eventId,
                               String nodeId)

Add a completion marker that signifies a node has completed an event.

Parameters:

eventId -

nodeId -

Returns:

findSystemEventDetailByNameAndValueAndEventType

SystemEventDetail findSystemEventDetailByNameAndValueAndEventType(String eventDetailsName,
                                                                  String eventDetailValue,
                                                                  String eventType)