com.broadleafcommerce.jobsevents.domain.dto

Class SystemEventDTO

java.lang.Object

com.broadleafcommerce.jobsevents.domain.dto.SystemEventDTO

All Implemented Interfaces:

SystemEvent, Serializable

public class SystemEventDTO
extends Object
implements SystemEvent

This dto class is used to represent a SystemEvent entity during event consumption. The dto is used when system event compression has taken place. See SystemEventCompressionHelper for more information.

Author:

Jeff Fischer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	canRetry
protected Date	created
protected Boolean	enabled
protected Map<String,SystemEventDetail>	eventDetails
protected boolean	passedConsumption
protected Integer	priority
protected Long	processId
protected Long	processStatusMarker
protected Integer	retryCount
protected EventScopeType	scopeType
protected Boolean	serialExecution
protected String	type
protected Boolean	universal
protected EventWorkerType	workerType

Constructor Summary

Constructors

Constructor and Description
SystemEventDTO(SystemEvent event)

Method Summary

Modifier and Type	Method and Description
Boolean	getCanResume() This differs from SystemEvent.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	getProcessId() A soft reference to an event's process record
Long	getProcessStatusMarker() 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	setProcessId(Long processId)
void	setProcessStatusMarker(Long processStatusMarker)
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)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

eventDetails

protected Map<String,SystemEventDetail> eventDetails

type

protected String type

created

protected Date created

scopeType

protected EventScopeType scopeType

workerType

protected EventWorkerType workerType

processStatusMarker

protected Long processStatusMarker

processId

protected Long processId

enabled

protected Boolean enabled

universal

protected Boolean universal

serialExecution

protected Boolean serialExecution

canRetry

protected Boolean canRetry

retryCount

protected Integer retryCount

priority

protected Integer priority

passedConsumption

protected boolean passedConsumption

Constructor Detail

SystemEventDTO

public SystemEventDTO(SystemEvent event)

Method Detail

getCreated

public Date getCreated()

Description copied from interface: SystemEvent

When the event was created.

Specified by:

getCreated in interface SystemEvent

Returns:

setCreated

public void setCreated(Date created)

Specified by:

setCreated in interface SystemEvent

getEventDetails

public Map<String,SystemEventDetail> getEventDetails()

Description copied from interface: SystemEvent

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

Specified by:

getEventDetails in interface SystemEvent

Returns:

setEventDetails

public void setEventDetails(Map<String,SystemEventDetail> eventDetails)

Specified by:

setEventDetails in interface SystemEvent

getId

public Long getId()

Specified by:

getId in interface SystemEvent

setId

public void setId(Long id)

Specified by:

setId in interface SystemEvent

getType

public String getType()

Description copied from interface: SystemEvent

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

Specified by:

getType in interface SystemEvent

Returns:

setType

public void setType(String type)

Specified by:

setType in interface SystemEvent

getScopeType

public EventScopeType getScopeType()

Description copied from interface: SystemEvent

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 (SystemEvent.getWorkerType() nodes in the cluster.

Specified by:

getScopeType in interface SystemEvent

Returns:

setScopeType

public void setScopeType(EventScopeType scopeType)

Specified by:

setScopeType in interface SystemEvent

getWorkerType

public EventWorkerType getWorkerType()

Description copied from interface: SystemEvent

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

Specified by:

getWorkerType in interface SystemEvent

Returns:

setWorkerType

public void setWorkerType(EventWorkerType workerType)

Specified by:

setWorkerType in interface SystemEvent

getEnabled

public Boolean getEnabled()

Description copied from interface: SystemEvent

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

Specified by:

getEnabled in interface SystemEvent

Returns:

setEnabled

public void setEnabled(Boolean enabled)

Specified by:

setEnabled in interface SystemEvent

getProcessStatusMarker

public Long getProcessStatusMarker()

Description copied from interface: SystemEvent

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.

Specified by:

getProcessStatusMarker in interface SystemEvent

Returns:

setProcessStatusMarker

public void setProcessStatusMarker(Long processStatusMarker)

Specified by:

setProcessStatusMarker in interface SystemEvent

getProcessId

public Long getProcessId()

Description copied from interface: SystemEvent

A soft reference to an event's process record

Specified by:

getProcessId in interface SystemEvent

Returns:

setProcessId

public void setProcessId(Long processId)

Specified by:

setProcessId in interface SystemEvent

getUniversal

public Boolean getUniversal()

Description copied from interface: SystemEvent

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.

Specified by:

getUniversal in interface SystemEvent

Returns:

setUniversal

public void setUniversal(Boolean universal)

Specified by:

setUniversal in interface SystemEvent

getSerialExecution

public Boolean getSerialExecution()

Description copied from interface: SystemEvent

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

Specified by:

getSerialExecution in interface SystemEvent

Returns:

See Also:

SerialEventLock

setSerialExecution

public void setSerialExecution(Boolean serialExecution)

Specified by:

setSerialExecution in interface SystemEvent

getRetryCount

public Integer getRetryCount()

Description copied from interface: SystemEvent

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

Specified by:

getRetryCount in interface SystemEvent

Returns:

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

setRetryCount

public void setRetryCount(Integer retryCount)

Description copied from interface: SystemEvent

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

Specified by:

setRetryCount in interface SystemEvent

Parameters:

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

getCanRetry

public Boolean getCanRetry()

Specified by:

getCanRetry in interface SystemEvent

setCanRetry

public void setCanRetry(Boolean canRetry)

Specified by:

setCanRetry in interface SystemEvent

isPassedConsumption

public boolean isPassedConsumption()

Description copied from interface: SystemEvent

Whether the event was successfully consumed

Specified by:

isPassedConsumption in interface SystemEvent

Returns:

setPassedConsumption

public void setPassedConsumption(boolean passedConsumption)

Specified by:

setPassedConsumption in interface SystemEvent

getPriority

public Integer getPriority()

Description copied from interface: SystemEvent

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.

Specified by:

getPriority in interface SystemEvent

Returns:

setPriority

public void setPriority(Integer priority)

Specified by:

setPriority in interface SystemEvent

getCanResume

public Boolean getCanResume()

Description copied from interface: SystemEvent

This differs from SystemEvent.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 ProcessStatusManager for more information.

Specified by:

getCanResume in interface SystemEvent

Returns:

toString

public String toString()

Overrides:

toString in class Object