Package com.codebarrel.automation.api.service

Class AutomationConfigServiceImpl

java.lang.Object

com.codebarrel.automation.api.service.AutomationConfigServiceImpl

All Implemented Interfaces:

AutomationConfigService, RuleChangePublisher

public class AutomationConfigServiceImpl
extends Object
implements AutomationConfigService

Field Summary

Fields inherited from interface com.codebarrel.automation.api.service.AutomationConfigService

RULE_DISABLED_MSG

Constructor Summary

Constructors

Constructor

Description

AutomationConfigServiceImpl(UserService userService, I18nFactory i18nFactory, RuleComponentsValidator ruleComponentsValidator, RuleComponentProvider componentProvider, AutomationConfigStore store, RuleScheduleService ruleScheduleService, AutomationLicenseService licenseService, FeedbackStore feedbackStore, AuditService auditService, RuleLabelService ruleLabelService, RuleUserResolver ruleUserResolver, AuditEventService auditEventService, RuleScopeService ruleScopeService, RuleAbortionService ruleAbortionService, AutomationObservabilityService observabilityService, AutomationPermissionService automationPermissionService, ApplicationRoleService applicationRoleService, FeatureManager featureFlagManager)

Method Summary

Modifier and Type	Method	Description
void	addLabelToRule(RemoteConnectUser remoteUser, TenantContext context, Long ruleId, Long labelId)	Adds a rule label to the given rule
List<RuleCreationResult>	bulkCreateRules(RemoteConnectUser remoteUser, TenantContext context, CreateReason reason, List<com.codebarrel.automation.api.config.RuleConfigBean> rulesToCreate)	Bulk creates a bunch of rules.
io.atlassian.fugue.Either<ErrorCollection,com.codebarrel.automation.api.config.RuleConfigBean>	createRule(RemoteConnectUser remoteUser, TenantContext context, com.codebarrel.automation.api.config.RuleConfigBean request)	Creates a new rule.
void	delete(RemoteConnectUser remoteUser, TenantContext context, Long ruleId)	Deletes the rule with the id provided.
void	delete(RemoteConnectUser remoteUser, TenantContext context, Long ruleId, String deletedErrorKey)	Deletes the rule with the id provided.
void	deleteAssociatedRuleProjects(TenantContext context, String... projectIds)	Removes rules association with the given project id, also removes those rules if only one exists
int	disableAllRules(TenantContext tenant, String disabledAuditMessageKey)	Will disable all rules on a particular tenant.
void	disableRule(TenantContext context, Long ruleId, String disabledAuditMessageKey)	This is an 'internal' method to be called by the rule executor when an execution loop may have been detected.
void	disableRuleAfterFailures(TenantContext context, Long ruleId, State failureState, int numConsecutiveFailures)	Will check the audit log for this rule to see if the most recent executions all had the specified failurestate.
long	getEnabledRuleCount(TenantContext context)	Counts enabled rules on a tenant.
List<com.codebarrel.automation.api.config.RuleConfigBean>	getMatchingRules(TenantContext context, Set<String> projectIds)	Retrieves all enabled rules that apply to the provided event.
Optional<com.codebarrel.automation.api.config.RuleConfigBean>	getRule(TenantContext context, Long ruleId)	Retrieve a rule by id
long	getRuleCount(TenantContext context)	Returns a count of all the rules for the tenant
Optional<com.codebarrel.automation.api.config.RuleConfigBean>	getRuleForBranch(TenantContext context, AutomationEvent event)	Retrieves the rule for a Branched rule
Map<Long,String>	getRuleNames(List<Long> ruleIds)	Retrieve rule names by rule ids
List<com.codebarrel.automation.api.config.RuleConfigBean>	getRules(TenantContext context, String projectId)	Get all rules for a given project.
Optional<com.codebarrel.automation.api.config.ComponentConfigBean>	getScheduledTriggerConfig(TenantContext context, Long ruleId)	This will attempt to retrieve the scheduled trigger config to be used by the RuleScheduleService.
boolean	hasRulesInScope(TenantContext context, Long projectId)	Whether there are rules specifically in the given scope Returns false for projectId = 10000 when all rules are global -- the rules MUST be specific to the project.
void	importRules(RemoteConnectUser remoteUser, TenantContext context, List<com.codebarrel.automation.api.config.RuleConfigBean> rules)	Performs actual import of automation rules.
io.atlassian.fugue.Either<ErrorCollection,ExternalizedRuleReaderResult>	parseRulesToImport(RemoteConnectUser remoteUser, TenantContext context, ExternalizedRuleReaderResult export)	Attempts to parse and perform basic validation of the provided rule export.
void	registerRuleChangedListener(RuleChangeListener listener)
void	removeLabelFromRule(RemoteConnectUser remoteUser, TenantContext context, Long ruleId, Long labelId)	Removes a label from a given rule
void	unregisterRuleChangedListener(RuleChangeListener listener)
io.atlassian.fugue.Either<ErrorCollection,com.codebarrel.automation.api.config.RuleConfigBean>	updateRule(RemoteConnectUser remoteUser, TenantContext context, com.codebarrel.automation.api.config.RuleConfigBean request, boolean dryrun)	Updates the rule with the provided configuration.

Methods inherited from class java.lang.Object

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

Constructor Details

AutomationConfigServiceImpl

@Inject
public AutomationConfigServiceImpl(UserService userService,
 I18nFactory i18nFactory,
 RuleComponentsValidator ruleComponentsValidator,
 RuleComponentProvider componentProvider,
 AutomationConfigStore store,
 RuleScheduleService ruleScheduleService,
 AutomationLicenseService licenseService,
 FeedbackStore feedbackStore,
 AuditService auditService,
 RuleLabelService ruleLabelService,
 RuleUserResolver ruleUserResolver,
 AuditEventService auditEventService,
 RuleScopeService ruleScopeService,
 RuleAbortionService ruleAbortionService,
 AutomationObservabilityService observabilityService,
 AutomationPermissionService automationPermissionService,
 ApplicationRoleService applicationRoleService,
 FeatureManager featureFlagManager)

Method Details

getRuleForBranch

public Optional<com.codebarrel.automation.api.config.RuleConfigBean> getRuleForBranch(TenantContext context,
 AutomationEvent event)

Description copied from interface: AutomationConfigService

Retrieves the rule for a Branched rule

Specified by:

getRuleForBranch in interface AutomationConfigService

Parameters:

context - The tenant context to look up rules for

event - The automation event for the branch

Returns:

a rule that represents the branch

getMatchingRules

public List<com.codebarrel.automation.api.config.RuleConfigBean> getMatchingRules(TenantContext context,
 Set<String> projectIds)

Description copied from interface: AutomationConfigService

Retrieves all enabled rules that apply to the provided event. This does NOT filter by the trigger.canHandle method

Specified by:

getMatchingRules in interface AutomationConfigService

Parameters:

context - The tenant context to look up rules for

projectIds - The project context to find matching rules for

Returns:

a list of matching automation rules that can handle the provided event

getRules

public List<com.codebarrel.automation.api.config.RuleConfigBean> getRules(TenantContext context,
 String projectId)

Description copied from interface: AutomationConfigService

Get all rules for a given project.

Specified by:

getRules in interface AutomationConfigService

Parameters:

context - The tenant context to look up rules for

projectId - The id for the project

Returns:

List of automation rules in this project and tenant

getRuleCount

public long getRuleCount(TenantContext context)

Description copied from interface: AutomationConfigService

Returns a count of all the rules for the tenant

Specified by:

getRuleCount in interface AutomationConfigService

Parameters:

context - The tenant context to look up rule count for

Returns:

rule count

hasRulesInScope

public boolean hasRulesInScope(TenantContext context,
 @Nullable
 Long projectId)

Description copied from interface: AutomationConfigService

Whether there are rules specifically in the given scope Returns false for projectId = 10000 when all rules are global -- the rules MUST be specific to the project.

Specified by:

hasRulesInScope in interface AutomationConfigService

Parameters:

context - The tenant context to look up rule count for

projectId - The scope to retrieve rules for. Null = Global.

getEnabledRuleCount

public long getEnabledRuleCount(TenantContext context)

Description copied from interface: AutomationConfigService

Counts enabled rules on a tenant.

Specified by:

getEnabledRuleCount in interface AutomationConfigService

Parameters:

context - The tenant

Returns:

count of enabled rules

disableAllRules

public int disableAllRules(TenantContext tenant,
 String disabledAuditMessageKey)

Description copied from interface: AutomationConfigService

Will disable all rules on a particular tenant.

Specified by:

disableAllRules in interface AutomationConfigService

Parameters:

tenant - The tenant

disabledAuditMessageKey - The i18n message that will be written to the audit log

Returns:

the number of rules actually disabled

getRule

public Optional<com.codebarrel.automation.api.config.RuleConfigBean> getRule(TenantContext context,
 Long ruleId)

Description copied from interface: AutomationConfigService

Retrieve a rule by id

Specified by:

getRule in interface AutomationConfigService

Parameters:

context - The tenant context to look up the rule in

ruleId - The id of the rule to retrieve

Returns:

the automation rule or empty if none exists.

getRuleNames

public Map<Long,String> getRuleNames(List<Long> ruleIds)

Description copied from interface: AutomationConfigService

Retrieve rule names by rule ids

Specified by:

getRuleNames in interface AutomationConfigService

Parameters:

ruleIds - The ids of rules to retrieve

Returns:

Map of rule id to rule name

getScheduledTriggerConfig

public Optional<com.codebarrel.automation.api.config.ComponentConfigBean> getScheduledTriggerConfig(TenantContext context,
 Long ruleId)

Description copied from interface: AutomationConfigService

This will attempt to retrieve the scheduled trigger config to be used by the RuleScheduleService. May return empty if the rule doesn't exist, or if the trigger isn't a scheduled trigger.

Specified by:

getScheduledTriggerConfig in interface AutomationConfigService

Parameters:

context - The tenant context to look up the rule in

ruleId - The id of the rule to retrieve

Returns:

The schedule trigger config or empty

bulkCreateRules

public List<RuleCreationResult> bulkCreateRules(RemoteConnectUser remoteUser,
 TenantContext context,
 CreateReason reason,
 List<com.codebarrel.automation.api.config.RuleConfigBean> rulesToCreate)

Description copied from interface: AutomationConfigService

Bulk creates a bunch of rules. Can be used for generating sample rules or imports

Specified by:

bulkCreateRules in interface AutomationConfigService

Parameters:

remoteUser - The user making the request

context - The tenant context to look up rules for

rulesToCreate - The rules to create

Returns:

A list of results.

createRule

public io.atlassian.fugue.Either<ErrorCollection,com.codebarrel.automation.api.config.RuleConfigBean> createRule(RemoteConnectUser remoteUser,
 TenantContext context,
 com.codebarrel.automation.api.config.RuleConfigBean request)

Description copied from interface: AutomationConfigService

Creates a new rule.

Specified by:

createRule in interface AutomationConfigService

Parameters:

remoteUser - The user making the request

context - The tenant context to look up rules for

request - Data needed to create the new rule

Returns:

The newly created rule or an error collection

updateRule

public io.atlassian.fugue.Either<ErrorCollection,com.codebarrel.automation.api.config.RuleConfigBean> updateRule(RemoteConnectUser remoteUser,
 TenantContext context,
 com.codebarrel.automation.api.config.RuleConfigBean request,
 boolean dryrun)

Description copied from interface: AutomationConfigService

Updates the rule with the provided configuration.

Specified by:

updateRule in interface AutomationConfigService

Parameters:

remoteUser - The user making the request

context - The project tenant context to look up rules for

request - Data needed to update the rule

dryrun - If true, only validate and do not save the rule

Returns:

The updated rule or an error collection

addLabelToRule

public void addLabelToRule(RemoteConnectUser remoteUser,
 TenantContext context,
 Long ruleId,
 Long labelId)

Description copied from interface: AutomationConfigService

Adds a rule label to the given rule

Specified by:

addLabelToRule in interface AutomationConfigService

Parameters:

remoteUser - The user making the request

context - The project tenant context to look up rules for

ruleId - The id of the rule to update

labelId - The id of the label to add

removeLabelFromRule

public void removeLabelFromRule(RemoteConnectUser remoteUser,
 TenantContext context,
 Long ruleId,
 Long labelId)

Description copied from interface: AutomationConfigService

Removes a label from a given rule

Specified by:

removeLabelFromRule in interface AutomationConfigService

Parameters:

remoteUser - The user making the request

context - The project tenant context to look up rules for

ruleId - The id of the rule to update

labelId - The id of the label to remove

disableRule

public void disableRule(TenantContext context,
 Long ruleId,
 String disabledAuditMessageKey)

Description copied from interface: AutomationConfigService

This is an 'internal' method to be called by the rule executor when an execution loop may have been detected.

Specified by:

disableRule in interface AutomationConfigService

Parameters:

context - The tenant context to look up rules for

ruleId - The id of the rule to disable

disabledAuditMessageKey - An i18n message to write to the audit log with the reason for disabling the rule

disableRuleAfterFailures

public void disableRuleAfterFailures(TenantContext context,
 Long ruleId,
 State failureState,
 int numConsecutiveFailures)

Description copied from interface: AutomationConfigService

Will check the audit log for this rule to see if the most recent executions all had the specified failurestate.

If so, the rule will be disabled.

Specified by:

disableRuleAfterFailures in interface AutomationConfigService

delete

public void delete(@Nullable
 RemoteConnectUser remoteUser,
 TenantContext context,
 Long ruleId)

Description copied from interface: AutomationConfigService

Deletes the rule with the id provided.

Specified by:

delete in interface AutomationConfigService

Parameters:

remoteUser - The user making the request

context - The project tenant context to look up rules for

ruleId - The id of the rule to delete

delete

public void delete(@Nullable
 RemoteConnectUser remoteUser,
 TenantContext context,
 Long ruleId,
 @Nullable
 String deletedErrorKey)

Description copied from interface: AutomationConfigService

Deletes the rule with the id provided.

Specified by:

delete in interface AutomationConfigService

Parameters:

remoteUser - The user making the request

context - The project tenant context to look up rules for

ruleId - The id of the rule to delete

deletedErrorKey - Reason key to display for the audit log message

deleteAssociatedRuleProjects

public void deleteAssociatedRuleProjects(TenantContext context,
 String... projectIds)

Description copied from interface: AutomationConfigService

Removes rules association with the given project id, also removes those rules if only one exists

Specified by:

deleteAssociatedRuleProjects in interface AutomationConfigService

Parameters:

context - The project tenant context remove associated projects

projectIds - List of project ids to delete

parseRulesToImport

public io.atlassian.fugue.Either<ErrorCollection,ExternalizedRuleReaderResult> parseRulesToImport(RemoteConnectUser remoteUser,
 TenantContext context,
 ExternalizedRuleReaderResult export)

Description copied from interface: AutomationConfigService

Attempts to parse and perform basic validation of the provided rule export.

Specified by:

parseRulesToImport in interface AutomationConfigService

Parameters:

remoteUser - The user making the request

context - The project tenant context to look up rules for

export - Pre-processed rules that were read from file uploaded by client

Returns:

Either an error collection or the parsed rules to import

importRules

public void importRules(RemoteConnectUser remoteUser,
 TenantContext context,
 List<com.codebarrel.automation.api.config.RuleConfigBean> rules)

Description copied from interface: AutomationConfigService

Performs actual import of automation rules. This is a dumb import in the sense that it will simply shove the rule configs into the DB and not perform much validation (other than checking for duplicate names).

Specified by:

importRules in interface AutomationConfigService

Parameters:

remoteUser - The user making the request

context - The project tenant context to look up rules for

rules - The rules to import.

registerRuleChangedListener

public void registerRuleChangedListener(RuleChangeListener listener)

Specified by:

registerRuleChangedListener in interface RuleChangePublisher

unregisterRuleChangedListener

public void unregisterRuleChangedListener(RuleChangeListener listener)

Specified by:

unregisterRuleChangedListener in interface RuleChangePublisher