com.broadleafcommerce.jobsevents.dao

Class DatabaseSystemEventDaoImpl

java.lang.Object

com.broadleafcommerce.jobsevents.dao.DatabaseSystemEventDaoImpl

All Implemented Interfaces:

DatabaseSystemEventDao

@Repository(value="blDatabaseSystemEventDao")
public class DatabaseSystemEventDaoImpl
extends Object
implements DatabaseSystemEventDao

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
static String	BC_DISABLE_SCHEDULED_JOB
static String	BC_UPDATE_SCHEDULED_JOB_EXECUTED
protected javax.persistence.EntityManager	em
protected int	eventCandidateDeletionPageSize
protected IncognitoFilterStateHelper	helper

Constructor Summary

Constructors

Constructor and Description
DatabaseSystemEventDaoImpl()

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> toRetryFromError, int startPos, int pageSize, EventWorkerType workerType) Retrieve events of type DURABLE_GLOBAL.
Long	getLatestDurableEventsCount(Date lowDate, Date lastProcessedDate, List<Long> alreadyProcessedOnDate, List<Long> toRetryFromError, 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.
boolean	lockSerialEvent(SystemEvent systemEvent)
boolean	lockSerialEvent(SystemEvent systemEvent, String nodeId) 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.
void	save(List<SystemEvent> events)
MasterScheduledJobNode	save(MasterScheduledJobNode node)
RegisteredNode	save(RegisteredNode node)
ScheduledJob	save(ScheduledJob job)
SystemEvent	save(SystemEvent systemEvent)
protected SystemEvent	saveInternal(SystemEvent systemEvent, boolean preventDuplicates)
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)

Methods inherited from class java.lang.Object

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

Field Detail

BC_UPDATE_SCHEDULED_JOB_EXECUTED

public static final String BC_UPDATE_SCHEDULED_JOB_EXECUTED

See Also:

Constant Field Values

BC_DISABLE_SCHEDULED_JOB

public static final String BC_DISABLE_SCHEDULED_JOB

See Also:

Constant Field Values

em

protected javax.persistence.EntityManager em

helper

protected IncognitoFilterStateHelper helper

eventCandidateDeletionPageSize

@Value(value="${database.event.candidate.deletion.pagesize:50}")
protected int eventCandidateDeletionPageSize

Constructor Detail

DatabaseSystemEventDaoImpl

public DatabaseSystemEventDaoImpl()

Method Detail

nodeExists

public boolean nodeExists(String nodeId)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

nodeExists in interface DatabaseSystemEventDao

Returns:

See Also:

RegisteredNode

find

public RegisteredNode find(String nodeId)

Specified by:

find in interface DatabaseSystemEventDao

findSystemEvent

public SystemEvent findSystemEvent(Long eventId)

Specified by:

findSystemEvent in interface DatabaseSystemEventDao

addFinishedNode

public ProcessedEvent addFinishedNode(Long eventId,
                                      String nodeId)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

addFinishedNode in interface DatabaseSystemEventDao

Returns:

findMasterNode

public MasterScheduledJobNode findMasterNode()

Specified by:

findMasterNode in interface DatabaseSystemEventDao

findMasterDeployNode

public MasterScheduledJobNode findMasterDeployNode()

Specified by:

findMasterDeployNode in interface DatabaseSystemEventDao

getLatestEvents

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

Description copied from interface: DatabaseSystemEventDao

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.

Specified by:

getLatestEvents in interface DatabaseSystemEventDao

Parameters:

lowDate - - deprecated (no longer used in query)

Returns:

getLatestGlobalEvents

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

Description copied from interface: DatabaseSystemEventDao

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 DatabaseSystemEventDao.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.

Specified by:

getLatestGlobalEvents in interface DatabaseSystemEventDao

Returns:

getLatestPriorityEvents

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

Description copied from interface: DatabaseSystemEventDao

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.

Specified by:

getLatestPriorityEvents in interface DatabaseSystemEventDao

Returns:

getLatestScheduledDeployEvents

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

Specified by:

getLatestScheduledDeployEvents in interface DatabaseSystemEventDao

getLatestDurableEvents

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

Description copied from interface: DatabaseSystemEventDao

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.

Specified by:

getLatestDurableEvents in interface DatabaseSystemEventDao

Returns:

getLatestDurableEventsCount

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

Specified by:

getLatestDurableEventsCount in interface DatabaseSystemEventDao

getMaxEventDateForNode

public Date getMaxEventDateForNode(EventWorkerType workerType,
                                   String nodeId)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

getMaxEventDateForNode in interface DatabaseSystemEventDao

Returns:

save

public ScheduledJob save(ScheduledJob job)

Specified by:

save in interface DatabaseSystemEventDao

readScheduledJobs

public List<ScheduledJob> readScheduledJobs()

Specified by:

readScheduledJobs in interface DatabaseSystemEventDao

readNewScheduledJobs

public List<ScheduledJob> readNewScheduledJobs()

Specified by:

readNewScheduledJobs in interface DatabaseSystemEventDao

markJobAsExecuted

public void markJobAsExecuted(Long scheduledJobId)

Specified by:

markJobAsExecuted in interface DatabaseSystemEventDao

getLatestEventsCount

public Long getLatestEventsCount(Date lowDate,
                                 EventWorkerType workerType)

Specified by:

getLatestEventsCount in interface DatabaseSystemEventDao

createNewNode

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

Specified by:

createNewNode in interface DatabaseSystemEventDao

save

public RegisteredNode save(RegisteredNode node)

Specified by:

save in interface DatabaseSystemEventDao

updateNodeTimestamp

public void updateNodeTimestamp(String nodeId)

Specified by:

updateNodeTimestamp in interface DatabaseSystemEventDao

getNodeTimestamp

public Date getNodeTimestamp(String nodeId)

Specified by:

getNodeTimestamp in interface DatabaseSystemEventDao

refresh

public RegisteredNode refresh(RegisteredNode node)

Specified by:

refresh in interface DatabaseSystemEventDao

updateMaxEventDate

public void updateMaxEventDate(String nodeId,
                               Date maxEventDate)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

updateMaxEventDate in interface DatabaseSystemEventDao

updateMaxEventDate

public void updateMaxEventDate(Date maxEventDate)

Specified by:

updateMaxEventDate in interface DatabaseSystemEventDao

save

public MasterScheduledJobNode save(MasterScheduledJobNode node)

Specified by:

save in interface DatabaseSystemEventDao

updateMasterTimestamp

public void updateMasterTimestamp()

Specified by:

updateMasterTimestamp in interface DatabaseSystemEventDao

updateMasterDeployTimestamp

public void updateMasterDeployTimestamp()

Specified by:

updateMasterDeployTimestamp in interface DatabaseSystemEventDao

delete

public void delete(MasterScheduledJobNode node)

Specified by:

delete in interface DatabaseSystemEventDao

purgeDerelictMasterNode

public void purgeDerelictMasterNode(Date updated)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

purgeDerelictMasterNode in interface DatabaseSystemEventDao

purgeDerelictMasterDeployNode

public void purgeDerelictMasterDeployNode(Date updated)

Specified by:

purgeDerelictMasterDeployNode in interface DatabaseSystemEventDao

save

public SystemEvent save(SystemEvent systemEvent)

Specified by:

save in interface DatabaseSystemEventDao

clear

public void clear()

Description copied from interface: DatabaseSystemEventDao

Perform an EntityManager.clear()

Specified by:

clear in interface DatabaseSystemEventDao

refresh

public void refresh(SystemEvent event)

Specified by:

refresh in interface DatabaseSystemEventDao

saveInternal

protected SystemEvent saveInternal(SystemEvent systemEvent,
                                   boolean preventDuplicates)

lockSerialEvent

public boolean lockSerialEvent(SystemEvent systemEvent,
                               String nodeId)

Description copied from interface: DatabaseSystemEventDao

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.

Specified by:

lockSerialEvent in interface DatabaseSystemEventDao

Returns:

lockSerialEvent

public boolean lockSerialEvent(SystemEvent systemEvent)

Specified by:

lockSerialEvent in interface DatabaseSystemEventDao

lockGlobalEvent

@Deprecated
public boolean lockGlobalEvent(SystemEvent systemEvent,
                                           Long nodeId)

Deprecated.

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

lockGlobalEvent in interface DatabaseSystemEventDao

Returns:

removeLock

@Deprecated
public void removeLock(SystemEvent systemEvent)

Deprecated.

Description copied from interface: DatabaseSystemEventDao

Purge the lock record from the database

Specified by:

removeLock in interface DatabaseSystemEventDao

unlockSerialEvent

public void unlockSerialEvent(String key)

Specified by:

unlockSerialEvent in interface DatabaseSystemEventDao

optimisticUnlockSerialEvent

public boolean optimisticUnlockSerialEvent(String key)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

optimisticUnlockSerialEvent in interface DatabaseSystemEventDao

Returns:

disableEvent

public SystemEvent disableEvent(SystemEvent systemEvent)

Description copied from interface: DatabaseSystemEventDao

Disable an event so that it will not be processed.

Specified by:

disableEvent in interface DatabaseSystemEventDao

Returns:

startEventInUseState

public SystemEvent startEventInUseState(SystemEvent systemEvent)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

startEventInUseState in interface DatabaseSystemEventDao

Parameters:

systemEvent - event with scope type of VM

Returns:

finishEventInUseState

public SystemEvent finishEventInUseState(SystemEvent systemEvent)

Description copied from interface: DatabaseSystemEventDao

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.

Specified by:

finishEventInUseState in interface DatabaseSystemEventDao

Parameters:

systemEvent - event with scope type of VM

Returns:

deleteOldNodes

public void deleteOldNodes(Date thresholdDate)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

deleteOldNodes in interface DatabaseSystemEventDao

findActiveNodes

public List<RegisteredNode> findActiveNodes(Date thresholdDate)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

findActiveNodes in interface DatabaseSystemEventDao

Returns:

disableScheduledJob

public void disableScheduledJob(Long jobId)

Specified by:

disableScheduledJob in interface DatabaseSystemEventDao

deleteJob

public void deleteJob(Long jobId)

Description copied from interface: DatabaseSystemEventDao

Remove job based on the provided job id.

Specified by:

deleteJob in interface DatabaseSystemEventDao

findJob

public ScheduledJob findJob(Long id)

Specified by:

findJob in interface DatabaseSystemEventDao

deleteExecutedSingleUseJobs

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

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

deleteExecutedSingleUseJobs in interface DatabaseSystemEventDao

deleteOldEvents

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

Description copied from interface: DatabaseSystemEventDao

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.

Specified by:

deleteOldEvents in interface DatabaseSystemEventDao

enableEventsForProcess

public void enableEventsForProcess(Long processStatusMarker)

Description copied from interface: DatabaseSystemEventDao

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

Specified by:

enableEventsForProcess in interface DatabaseSystemEventDao

save

public void save(List<SystemEvent> events)

Specified by:

save in interface DatabaseSystemEventDao

findSystemEventDetailByNameAndValueAndEventType

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

Specified by:

findSystemEventDetailByNameAndValueAndEventType in interface DatabaseSystemEventDao