DatabaseSystemEventNode (broadleaf-jobs-events 2.2.9-GA 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 Deprecated 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, QueueStatusThreadPoolTaskExecutor executor)` Iterate through a list of events and provide those events to the appropriate `SystemEventConsumer` instances.
`int`	`getDurableEventsPerPoll()` Deprecated. Not used internally
`Map<String,List<SystemEventConsumer>>`	`getEventConsumers()` All the `SystemEventConsumer` instances registered in Spring.
`int`	`getEventsPerPoll()` The number of `EventScopeType.VM` events to retrieve in each poll.
`int`	`getGlobalEventsPerPoll()` The number of `EventScopeType.GLOBAL` events to retrieve in each poll.
`long`	`getGlobalJobThreadPoolCount()` The number of threads actively polling for available `EventScopeType.GLOBAL` events.
`long`	`getJobThreadPoolCount()` The number of threads actively polling for available `EventScopeType.VM` events.
`long`	`getMissedDurableEventsPollingThresholdSeconds()` The maximum amount of time into the past that durable events should be retrieved.
`String`	`getNodeId()`
`RegisteredNode`	`getNodeRegistration()` Get the `RegisteredNode` associated.
`long`	`getPollingIntervalSeconds()` The wait time between each polling attempt for available events.
`int`	`getPriorityEventsPerPoll()` The number of priority events to retrieve in each poll.
`long`	`getPriorityJobThreadPoolCount()` The number of threads actively polling for priority events (`EventScopeType.VM` or `EventScopeType.GLOBAL`).
`DatabaseSystemEventDao`	`getSystemEventDao()`
`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)`
`boolean`	`isCreated()`
`boolean`	`isPause()` Whether or not this node is paused.
`void`	`setDurableEventsPerPoll(int missedDurableEventsPerPoll)` Deprecated. Not used internally
`void`	`setEventConsumers(Map<String,List<SystemEventConsumer>> eventConsumers)`
`void`	`setEventsPerPoll(int eventsPerPoll)`
`void`	`setGlobalEventsPerPoll(int globalEventsPerPoll)`
`void`	`setGlobalJobThreadPoolCount(long globalJobThreadPoolCount)`
`void`	`setJobThreadPoolCount(long jobThreadPoolCount)`
`void`	`setMissedDurableEventsPollingThresholdSeconds(long missedDurableEventsPollingThreshold)`
`void`	`setPause(boolean pause)`
`void`	`setPollingIntervalSeconds(long pollingInterval)`
`void`	`setPriorityEventsPerPoll(int priorityEventsPerPoll)`
`void`	`setPriorityJobThreadPoolCount(long priorityJobThreadPoolCount)`

- 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 EventScopeType.VM events. Defaults to 2. See DatabaseSystemEventNodeImpl.jobThreadPoolCount for more info.
    
    Returns:
  - setJobThreadPoolCount
```
void setJobThreadPoolCount(long jobThreadPoolCount)
```
  - getPriorityJobThreadPoolCount
```
long getPriorityJobThreadPoolCount()
```
    The number of threads actively polling for priority events (EventScopeType.VM or EventScopeType.GLOBAL). See DatabaseSystemEventNodeImpl.priorityJobThreadPoolCount for more info. Default is 4.
    
    Returns:
  - setPriorityJobThreadPoolCount
```
void setPriorityJobThreadPoolCount(long priorityJobThreadPoolCount)
```
  - getGlobalJobThreadPoolCount
```
long getGlobalJobThreadPoolCount()
```
    The number of threads actively polling for available EventScopeType.GLOBAL events. Defaults to 3. See DatabaseSystemEventNodeImpl.globalJobThreadPoolCount for more info.
    
    Returns:
  - setGlobalJobThreadPoolCount
```
void setGlobalJobThreadPoolCount(long globalJobThreadPoolCount)
```
  - 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)
```
  - getSystemEventDao
```
DatabaseSystemEventDao getSystemEventDao()
```
  - invalidateCacheRegion
```
void invalidateCacheRegion(String region)
```
  - getEventsPerPoll
```
int getEventsPerPoll()
```
    The number of EventScopeType.VM 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.
    See the discussion on getPriorityEventsPerPoll() for similar configuration related to special priority events.
    
    Returns:
  - setEventsPerPoll
```
void setEventsPerPoll(int eventsPerPoll)
```
  - getPriorityEventsPerPoll
```
int getPriorityEventsPerPoll()
```
    The number of priority events to retrieve in each poll. Priority events have SystemEvent.getPriority() less than zero. Priority events are generally considered to be important functional events that consume very quickly (e.g. cache invalidations). Processing these events in their own queue attempts to guarantee a more timely processing, instead of having them queue up with standard, possibly long-running, events in the standard queue.
    The priority events per poll 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. The default value is 5. This does not include events of type GLOBAL_DURABLE.
    
    Returns:
  - setPriorityEventsPerPoll
```
void setPriorityEventsPerPoll(int priorityEventsPerPoll)
```
  - getGlobalEventsPerPoll
```
int getGlobalEventsPerPoll()
```
    The number of EventScopeType.GLOBAL 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.
    See the discussion on getPriorityEventsPerPoll() for similar configuration related to special priority events.
    
    Returns:
  - setGlobalEventsPerPoll
```
void setGlobalEventsPerPoll(int globalEventsPerPoll)
```
  - 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
```
@Deprecated
int getDurableEventsPerPoll()
```
    Deprecated. Not used internally
    
    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
```
@Deprecated
void setDurableEventsPerPoll(int missedDurableEventsPerPoll)
```
    Deprecated. Not used internally
    
    Parameters:
    
    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,
                   QueueStatusThreadPoolTaskExecutor executor)
```
    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)
    
    executor -
  - isCreated
```
boolean isCreated()
```
  - getNodeId
```
String getNodeId()
```
  - getNodeRegistration
```
RegisteredNode getNodeRegistration()
```
    Get the RegisteredNode associated. Every instance of DatabaseSystemEventNode creates a registration in the database.
    
    Returns:

Interface DatabaseSystemEventNode

Method Summary

Method Detail

isPause

setPause

getPollingIntervalSeconds

setPollingIntervalSeconds

getJobThreadPoolCount

setJobThreadPoolCount

getPriorityJobThreadPoolCount

setPriorityJobThreadPoolCount

getGlobalJobThreadPoolCount

setGlobalJobThreadPoolCount

getEventConsumers

setEventConsumers

invalidateCacheElement

invalidateCacheElement

getSystemEventDao

invalidateCacheRegion

getEventsPerPoll

setEventsPerPoll

getPriorityEventsPerPoll

setPriorityEventsPerPoll

getGlobalEventsPerPoll

setGlobalEventsPerPoll

determineHostWorkerType

consumeLocalEvent

getDurableEventsPerPoll

setDurableEventsPerPoll

getMissedDurableEventsPollingThresholdSeconds

setMissedDurableEventsPollingThresholdSeconds

executeEvents

isCreated

getNodeId

getNodeRegistration