com.broadleafcommerce.jobsevents.domain

Interface SystemEvent

All Superinterfaces:

Serializable

All Known Implementing Classes:

SystemEventImpl

public interface SystemEvent
extends Serializable

Describes an event to be immediately executed by the system in an asynchronous fashion. Events are generated directly upon demand SystemEventSender, or as the result of the scheduled firing of a job.

Author:

Jeff Fischer

See Also:

ScheduledJob, SystemEventSender

Method Summary

Modifier and Type	Method and Description
Boolean	getCanResume() This differs from getCanRetry() in that this setting determines whether or not the event is capable is resuming operation after being interrupted as the result of catastrophic server failure, or other database connection failure.
Boolean	getCanRetry()
Date	getCreated() When the event was created.
Boolean	getEnabled() Whether the event is enabled.
Map<String,SystemEventDetail>	getEventDetails() Detailed information needed to consume the event appropriately.
Long	getId()
Integer	getPriority() The priority of an event.
Long	getProcessMarker() An arbitrary marker field used to group events together.
Integer	getRetryCount() Not currently supported.
EventScopeType	getScopeType() Describes how an event should be consumed.
Boolean	getSerialExecution() Whether this events should be the only event of it's type allowed to execute at once.
String	getType() Arbitrary string that identifies the event.
Boolean	getUniversal() Events marked as universal are considered to always be the same whenever they are fired.
EventWorkerType	getWorkerType() The type of node that is qualified to consume this event.
boolean	isPassedConsumption() Whether the event was successfully consumed
void	setCanRetry(Boolean canRetry)
void	setCreated(Date created)
void	setEnabled(Boolean enabled)
void	setEventDetails(Map<String,SystemEventDetail> eventDetails)
void	setId(Long id)
void	setPassedConsumption(boolean passedConsumption)
void	setPriority(Integer priority)
void	setProcessMarker(Long processMarker)
void	setRetryCount(Integer retryCount) Not currently supported.
void	setScopeType(EventScopeType scopeType)
void	setSerialExecution(Boolean serialExecution)
void	setType(String type)
void	setUniversal(Boolean universal)
void	setWorkerType(EventWorkerType workerType)

Method Detail

getCreated

Date getCreated()

When the event was created.

Returns:

setCreated

void setCreated(Date created)

getEventDetails

Map<String,SystemEventDetail> getEventDetails()

Detailed information needed to consume the event appropriately. Can come from the details on a ScheduledJob

Returns:

setEventDetails

void setEventDetails(Map<String,SystemEventDetail> eventDetails)

getId

Long getId()

setId

void setId(Long id)

getType

String getType()

Arbitrary string that identifies the event. Used to qualify an event consumer for a specific event SystemEventConsumer.getEventType()

Returns:

setType

void setType(String type)

getScopeType

EventScopeType getScopeType()

Describes how an event should be consumed. For example, VM events are executed on a single node, while GLOBAL events are executed by all qualifying (getWorkerType() nodes in the cluster.

Returns:

setScopeType

void setScopeType(EventScopeType scopeType)

getEnabled

Boolean getEnabled()

Whether the event is enabled. Events that are not enabled do not result in consumption.

Returns:

setEnabled

void setEnabled(Boolean enabled)

getProcessMarker

Long getProcessMarker()

An arbitrary marker field used to group events together. It's used by the system to enable an entire group of events at once for consumption.

Returns:

setProcessMarker

void setProcessMarker(Long processMarker)

getWorkerType

EventWorkerType getWorkerType()

The type of node that is qualified to consume this event.

Returns:

setWorkerType

void setWorkerType(EventWorkerType workerType)

getUniversal

Boolean getUniversal()

Events marked as universal are considered to always be the same whenever they are fired. If the code creating the event will always create the event in the same way using the same information, then it's safe to mark this field as true. Universal events benefit from a performance enhancement in which the system can detect duplicate waiting events that are the same and compress the events into a single event.

Returns:

setUniversal

void setUniversal(Boolean universal)

getSerialExecution

Boolean getSerialExecution()

Whether this events should be the only event of it's type allowed to execute at once.

Returns:

See Also:

SerialEventLock

setSerialExecution

void setSerialExecution(Boolean serialExecution)

getRetryCount

Integer getRetryCount()

Not currently supported. Will be supported in a future release.

Returns:

The number of times to try to consume the event before giving up

setRetryCount

void setRetryCount(Integer retryCount)

Not currently supported. Will be supported in a future release.

Parameters:

retryCount - The number of times to try to consume the event before giving up

getCanRetry

Boolean getCanRetry()

setCanRetry

void setCanRetry(Boolean canRetry)

isPassedConsumption

boolean isPassedConsumption()

Whether the event was successfully consumed

Returns:

setPassedConsumption

void setPassedConsumption(boolean passedConsumption)

getPriority

Integer getPriority()

The priority of an event. Events with a priority marked are executed in order and given preferential treatment of other events that do not offer a priority.

Returns:

setPriority

void setPriority(Integer priority)

getCanResume

Boolean getCanResume()

This differs from getCanRetry() in that this setting determines whether or not the event is capable is resuming operation after being interrupted as the result of catastrophic server failure, or other database connection failure. See ProcessManager for more information.

Returns: