org.broadleafcommerce.common.event

Class BroadleafSystemEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.broadleafcommerce.common.event.BroadleafApplicationEvent

org.broadleafcommerce.common.event.BroadleafSystemEvent

All Implemented Interfaces:

Serializable

public class BroadleafSystemEvent
extends BroadleafApplicationEvent

A BroadleafApplicationEvent used so that we can communicate with the ScheduledJobsAndEvents module without having a dependency on it. By publishing a Spring Event with this detail, the ScheduledJobsAndEvents module will listen for this event and create a corresponding com.broadleafcommerce.jobsevents.domain.SystemEvent to be consumed.

To send an event, inject the ApplicationContext and publish the event:

  @Autowired
 private ApplicationContext appCtx;

 ...

 appCtx.publishEvent(new BroadleafSystemEvent("CONSUMER_TYPE", BroadleafEventScopeType.VM, BroadleafEventWorkerType.SITE, true);
 

Author:

Jay Aisenbrey (cja769)

See Also:

ApplicationEventPublisher.publishEvent(org.springframework.context.ApplicationEvent), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BroadleafSystemEvent.BroadleafEventScopeType Constant for how the event should be consumed
static class	BroadleafSystemEvent.BroadleafEventWorkerType Which type of worker is qualified to handle the event

Nested classes/interfaces inherited from class org.broadleafcommerce.common.event.BroadleafApplicationEvent

BroadleafApplicationEvent.ContextVars

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,BroadleafSystemEventDetail>	detailMap
protected BroadleafSystemEvent.BroadleafEventScopeType	scopeType
protected String	type
protected boolean	universal
protected BroadleafSystemEvent.BroadleafEventWorkerType	workerType

Fields inherited from class org.broadleafcommerce.common.event.BroadleafApplicationEvent

context

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BroadleafSystemEvent(String type, BroadleafSystemEvent.BroadleafEventScopeType scopeType, BroadleafSystemEvent.BroadleafEventWorkerType workerType, boolean universal)
BroadleafSystemEvent(String type, Map<String,BroadleafSystemEventDetail> detailMap, BroadleafSystemEvent.BroadleafEventScopeType scopeType, BroadleafSystemEvent.BroadleafEventWorkerType workerType, boolean universal)

Method Summary

Modifier and Type	Method and Description
Map<String,BroadleafSystemEventDetail>	getDetailMap()
BroadleafSystemEvent.BroadleafEventScopeType	getScopeType()
String	getType()
BroadleafSystemEvent.BroadleafEventWorkerType	getWorkerType()
boolean	isUniversal() If this event is constructed the exact same way with the exact same data, we can gain a performance increase by combining multiple events into 1.
void	setDetailMap(Map<String,BroadleafSystemEventDetail> detailMap)
void	setScopeType(BroadleafSystemEvent.BroadleafEventScopeType scopeType)
void	setType(String type)
void	setUniversal(boolean universal)
void	setWorkerType(BroadleafSystemEvent.BroadleafEventWorkerType workerType)

Methods inherited from class org.broadleafcommerce.common.event.BroadleafApplicationEvent

getCatalogId, getContext, getCurrencyCode, getLocaleCode, getProfileId, getSiteId, getTimeZoneId

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

detailMap

protected Map<String,BroadleafSystemEventDetail> detailMap

type

protected String type

scopeType

protected BroadleafSystemEvent.BroadleafEventScopeType scopeType

workerType

protected BroadleafSystemEvent.BroadleafEventWorkerType workerType

universal

protected boolean universal

Constructor Detail

BroadleafSystemEvent

public BroadleafSystemEvent(String type,
                            Map<String,BroadleafSystemEventDetail> detailMap,
                            BroadleafSystemEvent.BroadleafEventScopeType scopeType,
                            BroadleafSystemEvent.BroadleafEventWorkerType workerType,
                            boolean universal)

Parameters:

type - should match the com.broadleafcommerce.jobsevents.service.SystemEventConsumer#getType

detailMap - details passed to the event consumer

scopeType - how the event should be consumed

workerType - what type of workers should consume it

universal - used for a performance optimization when sending multiple events at the same time, usually true

BroadleafSystemEvent

public BroadleafSystemEvent(String type,
                            BroadleafSystemEvent.BroadleafEventScopeType scopeType,
                            BroadleafSystemEvent.BroadleafEventWorkerType workerType,
                            boolean universal)

See Also:

BroadleafSystemEvent(String, Map, BroadleafEventScopeType, BroadleafEventWorkerType, boolean)

Method Detail

getDetailMap

public Map<String,BroadleafSystemEventDetail> getDetailMap()

setDetailMap

public void setDetailMap(Map<String,BroadleafSystemEventDetail> detailMap)

getType

public String getType()

setType

public void setType(String type)

getScopeType

public BroadleafSystemEvent.BroadleafEventScopeType getScopeType()

setScopeType

public void setScopeType(BroadleafSystemEvent.BroadleafEventScopeType scopeType)

getWorkerType

public BroadleafSystemEvent.BroadleafEventWorkerType getWorkerType()

setWorkerType

public void setWorkerType(BroadleafSystemEvent.BroadleafEventWorkerType workerType)

isUniversal

public boolean isUniversal()

If this event is constructed the exact same way with the exact same data, we can gain a performance increase by combining multiple events into 1.

Returns:

setUniversal

public void setUniversal(boolean universal)