Package com.codebarrel.automation.api.queue

Interface AutomationQueueStore

All Known Implementing Classes:

JiraAutomationQueueStore

public interface AutomationQueueStore

Store to be used by the AutomationQueue

Method Summary

Modifier and Type	Method	Description
long	addItem(Environment env, QueueItemBean item)
List<Long>	addItems(Environment environment, List<QueueItemBean> items)
Optional<QueueItemBean>	claimItem(Environment env, String claimant, ClaimLimits claimLimits)
List<QueueItemBean>	claimItems(Environment env, String claimant, ClaimLimits limits)
List<Long>	claimItemsById(Environment env, String claimant, ClaimLimits limits)
long	clearUnresolved(Environment env, Date olderThan)
List<AutomationQueueInsightByRule>	getAutomationQueueInsightByRule(int limit)	Gets automation queue events grouped by rule.
long	getCount(Environment env)
long	getEarliestUnprocessedItemCreatedTime()
Optional<QueueItemBean>	getItem(Environment env, long itemId)
Optional<QueueItemBean>	getItemAndMarkForProcessing(Environment env, long itemId)
long	getQueuedCountForAuditItem(Environment environment, long auditItemId)
QueueStatistics	getStatistics(Environment env)
boolean	isRuleInProgress(TenantContext context, long ruleId)
long	resolveItem(TenantExecution tenantExecution, long itemId)
Set<LegacyExecutionPair>	stopAllRuleExecutions(TenantContext context, long ruleId)	Stops the execution of an automation rule, and returns a set of all affected audit item ids (could be empty).
long	stopRuleExecution(TenantExecution execution)	Removes all items from the queue for this single rule execution.

Method Details

addItem

long addItem(Environment env,
 QueueItemBean item)

addItems

List<Long> addItems(Environment environment,
 List<QueueItemBean> items)

claimItems

List<QueueItemBean> claimItems(Environment env,
 String claimant,
 ClaimLimits limits)

claimItemsById

List<Long> claimItemsById(Environment env,
 String claimant,
 ClaimLimits limits)

claimItem

Optional<QueueItemBean> claimItem(Environment env,
 String claimant,
 ClaimLimits claimLimits)

resolveItem

long resolveItem(TenantExecution tenantExecution,
 long itemId)

clearUnresolved

long clearUnresolved(Environment env,
 Date olderThan)

getStatistics

QueueStatistics getStatistics(Environment env)

getItem

Optional<QueueItemBean> getItem(Environment env,
 long itemId)

getItemAndMarkForProcessing

Optional<QueueItemBean> getItemAndMarkForProcessing(Environment env,
 long itemId)

getQueuedCountForAuditItem

long getQueuedCountForAuditItem(Environment environment,
 long auditItemId)

stopAllRuleExecutions

Set<LegacyExecutionPair> stopAllRuleExecutions(TenantContext context,
 long ruleId)

Stops the execution of an automation rule, and returns a set of all affected audit item ids (could be empty).

Parameters:

context - The tenant to execute this for

ruleId - The id of the rule to stop

Returns:

Set of audit item ids affected.

stopRuleExecution

long stopRuleExecution(TenantExecution execution)

Removes all items from the queue for this single rule execution.

Parameters:

execution - the execution to remove

Returns:

number of queued items removed

isRuleInProgress

boolean isRuleInProgress(TenantContext context,
 long ruleId)

getCount

long getCount(Environment env)

getEarliestUnprocessedItemCreatedTime

long getEarliestUnprocessedItemCreatedTime()

getAutomationQueueInsightByRule

List<AutomationQueueInsightByRule> getAutomationQueueInsightByRule(int limit)

Gets automation queue events grouped by rule.

Parameters:

limit - the number of groups to return

Returns:

the events grouped by rule