DatabaseSystemEventNode (broadleaf-jobs-events 2.0.3-SNAPSHOT API)

All Known Implementing Classes:

DatabaseSystemEventNodeImpl
```
public interface DatabaseSystemEventNode
```
This class represents the functionality native to a node in an event processing cluster. A node is responsible for polling for appropriate events and consuming those events.

Author:

Jeff Fischer

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`consumeLocalEvent(SystemEvent event)` Cause asynchronous consumption of this event to occur in the same JVM, rather than provide to event to the cluster.
`EventWorkerType`	`determineHostWorkerType()` Determine if this is an ADMIN or SITE node
`void`	`executeEvents(List<SystemEvent> events, boolean durable)` Iterate through a list of events and provide those events to the appropriate `SystemEventConsumer` instances.
`int`	`getDurableEventsPerPoll()` The number of events of type DURABLE_GLOBAL to retrieve in each poll.
`Map<String,List<SystemEventConsumer>>`	`getEventConsumers()` All the `SystemEventConsumer` instances registered in Spring.
`int`	`getEventsPerPoll()` The number of events to retrieve in each poll.
`long`	`getJobThreadPoolCount()` The number of threads actively polling for available events.
`long`	`getMissedDurableEventsPollingThresholdSeconds()` The maximum amount of time into the past that durable events should be retrieved.
`Long`	`getNodeId()`
`NodeRegistration`	`getNodeRegistration()` Get the `NodeRegistration` associated.
`long`	`getPollingIntervalSeconds()` The wait time between each polling attempt for available events.
`void`	`invalidateCacheElement(String entityClass, String id)`
`void`	`invalidateCacheElement(String entityClass, String property, String id)` Utility method for initiating a cache invalidation event.
`void`	`invalidateCacheRegion(String region)`
`void`	`invalidateCategory(String id)`
`void`	`invalidateCustomer(String id)`
`void`	`invalidateOffer(String id)`
`void`	`invalidateProduct(String id)`
`boolean`	`isCreated()`
`boolean`	`isPause()` Whether or not this node is paused.
`void`	`setDurableEventsPerPoll(int missedDurableEventsPerPoll)`
`void`	`setEventConsumers(Map<String,List<SystemEventConsumer>> eventConsumers)`
`void`	`setEventsPerPoll(int eventsPerPoll)`
`void`	`setJobThreadPoolCount(long jobThreadPoolCount)`
`void`	`setMissedDurableEventsPollingThresholdSeconds(long missedDurableEventsPollingThreshold)`
`void`	`setPause(boolean pause)`
`void`	`setPollingIntervalSeconds(long pollingInterval)`

- Method Detail
  - isPause
```
boolean isPause()
```
    Whether or not this node is paused. Paused nodes still participate in heartbeat checks, but do not actively consume events.
    
    Returns:
  - setPause
```
void setPause(boolean pause)
```
  - getPollingIntervalSeconds
```
long getPollingIntervalSeconds()
```
    The wait time between each polling attempt for available events. This value can be decreased for quicker event consumption response times at the cost of increased database traffic. Defaults to 5.
    
    Returns:
  - setPollingIntervalSeconds
```
void setPollingIntervalSeconds(long pollingInterval)
```
  - getJobThreadPoolCount
```
long getJobThreadPoolCount()
```
    The number of threads actively polling for available events. Defaults to 1.
    
    Returns:
  - setJobThreadPoolCount
```
void setJobThreadPoolCount(long jobThreadPoolCount)
```
  - getEventConsumers
```
Map<String,List<SystemEventConsumer>> getEventConsumers()
```
    All the SystemEventConsumer instances registered in Spring.
    
    Returns:
  - setEventConsumers
```
void setEventConsumers(Map<String,List<SystemEventConsumer>> eventConsumers)
```
  - invalidateCacheElement
```
void invalidateCacheElement(String entityClass,
                            String property,
                            String id)
```
    Utility method for initiating a cache invalidation event.
    
    Parameters:
    
    entityClass -
    
    property -
    
    id -
  - invalidateCacheElement
```
void invalidateCacheElement(String entityClass,
                            String id)
```
  - invalidateProduct
```
void invalidateProduct(String id)
```
  - invalidateCategory
```
void invalidateCategory(String id)
```
  - invalidateOffer
```
void invalidateOffer(String id)
```
  - invalidateCustomer
```
void invalidateCustomer(String id)
```
  - invalidateCacheRegion
```
void invalidateCacheRegion(String region)
```
  - getEventsPerPoll
```
int getEventsPerPoll()
```
    The number of events to retrieve in each poll. This can be increased to process more events at any given time at the cost of prolonged CPU consumption. It is likely advantageous to throttle event consumption to avoid overly taxing the system and penalizing other operations. Also, smaller event processing groups allows the system to respond more quickly to events that utilize the priority feature (see SystemEvent.getPriority(). The default value is 5. This does not include events of type GLOBAL_DURABLE.
    
    Returns:
  - setEventsPerPoll
```
void setEventsPerPoll(int eventsPerPoll)
```
  - determineHostWorkerType
```
EventWorkerType determineHostWorkerType()
```
    Determine if this is an ADMIN or SITE node
    
    Returns:
  - consumeLocalEvent
```
void consumeLocalEvent(SystemEvent event)
```
    Cause asynchronous consumption of this event to occur in the same JVM, rather than provide to event to the cluster. This avenue also avoids persistence of the event in the database.
    
    Parameters:
    
    event -
  - getDurableEventsPerPoll
```
int getDurableEventsPerPoll()
```
    The number of events of type DURABLE_GLOBAL to retrieve in each poll. The default value is 250. Durable events are always processed in order and do not take advantage of SystemEvent.getPriority().
    
    Returns:
  - setDurableEventsPerPoll
```
void setDurableEventsPerPoll(int missedDurableEventsPerPoll)
```
  - getMissedDurableEventsPollingThresholdSeconds
```
long getMissedDurableEventsPollingThresholdSeconds()
```
    The maximum amount of time into the past that durable events should be retrieved. Durable events older than the threshold will be ignored. The default value is 604800 (7 days).
    
    Returns:
  - setMissedDurableEventsPollingThresholdSeconds
```
void setMissedDurableEventsPollingThresholdSeconds(long missedDurableEventsPollingThreshold)
```
  - executeEvents
```
void executeEvents(List<SystemEvent> events,
                   boolean durable)
```
    Iterate through a list of events and provide those events to the appropriate SystemEventConsumer instances.
    
    Parameters:
    
    events -
    
    durable - Whether or not these events are durable (i.e. GLOBAL_DURABLE)
  - isCreated
```
boolean isCreated()
```
  - getNodeId
```
Long getNodeId()
```
  - getNodeRegistration
```
NodeRegistration getNodeRegistration()
```
    Get the NodeRegistration associated. Every instance of DatabaseSystemEventNode creates a registration in the database.
    
    Returns:

Interface DatabaseSystemEventNode

Method Summary

Method Detail

isPause

setPause

getPollingIntervalSeconds

setPollingIntervalSeconds

getJobThreadPoolCount

setJobThreadPoolCount

getEventConsumers

setEventConsumers

invalidateCacheElement

invalidateCacheElement

invalidateProduct

invalidateCategory

invalidateOffer

invalidateCustomer

invalidateCacheRegion

getEventsPerPoll

setEventsPerPoll

determineHostWorkerType

consumeLocalEvent

getDurableEventsPerPoll

setDurableEventsPerPoll

getMissedDurableEventsPollingThresholdSeconds

setMissedDurableEventsPollingThresholdSeconds

executeEvents

isCreated

getNodeId

getNodeRegistration