org.alfresco.repo.rule.ruletrigger
Class RuleTriggerAbstractBase

java.lang.Object
  org.alfresco.repo.rule.ruletrigger.RuleTriggerAbstractBase

All Implemented Interfaces:

RuleTrigger

Direct Known Subclasses:

BeforeDeleteChildAssociationRuleTrigger, CreateNodeRuleTrigger, OnContentUpdateRuleTrigger, OnCreateChildAssociationRuleTrigger, OnMoveNodeRuleTrigger, OnPropertyUpdateRuleTrigger, RestoreNodeRuleTrigger, SingleAssocRefPolicyRuleTrigger, SingleNodeRefPolicyRuleTrigger

public abstract class RuleTriggerAbstractBase
extends java.lang.Object
implements RuleTrigger

Rule trigger abstract base

Field Summary

protected AuthenticationComponent	authenticationComponent
protected ContentService	contentService
protected org.alfresco.service.cmr.dictionary.DictionaryService	dictionaryService
protected boolean	executeRuleImmediately Indicates whether the rule should be executed immediately or at the end of the transaction.
protected org.alfresco.service.cmr.repository.NodeService	nodeService
protected PolicyComponent	policyComponent
protected RuleService	ruleService

Fields inherited from interface org.alfresco.repo.rule.ruletrigger.RuleTrigger

RULE_TRIGGER_NEW_NODES, RULE_TRIGGER_RENAMED_NODES

Constructor Summary

RuleTriggerAbstractBase()

Method Summary

protected boolean	areRulesEnabled() Helper method to allow triggers to check if rules are enabled or disabled (ALF-10839: Eliminate rule discovery overhead on property update when rules have been disabled)
void	registerRuleType(RuleType ruleType) Registration of an interested rule type
void	setAuthenticationComponent(AuthenticationComponent authenticationComponent) Set the authenticationComponent
void	setContentService(ContentService contentService) Set the content service
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService) Set the dictionary service
void	setExecuteRuleImmediately(boolean executeRuleImmediately) Sets the values that indicates whether the rule should be executed immediately or not.
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set the node service
void	setPolicyComponent(PolicyComponent policyComponent) Set the policy component
void	setRuleService(RuleService ruleService) Set the RuleService to assist with enabled/disabled check
protected void	triggerRules(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef) Trigger the rules that relate to any interested rule types for the node references passed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.repo.rule.ruletrigger.RuleTrigger

registerRuleTrigger

Field Detail

policyComponent

protected PolicyComponent policyComponent

nodeService

protected org.alfresco.service.cmr.repository.NodeService nodeService

contentService

protected ContentService contentService

authenticationComponent

protected AuthenticationComponent authenticationComponent

dictionaryService

protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService

ruleService

protected RuleService ruleService

executeRuleImmediately

protected boolean executeRuleImmediately

Indicates whether the rule should be executed immediately or at the end of the transaction. By default this is false as all rules are executed at the end of the transaction.

Constructor Detail

RuleTriggerAbstractBase

public RuleTriggerAbstractBase()

Method Detail

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)

Set the policy component

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Set the node service

setContentService

public void setContentService(ContentService contentService)

Set the content service

setAuthenticationComponent

public void setAuthenticationComponent(AuthenticationComponent authenticationComponent)

Set the authenticationComponent

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Set the dictionary service

setRuleService

public void setRuleService(RuleService ruleService)

Set the RuleService to assist with enabled/disabled check

setExecuteRuleImmediately

public void setExecuteRuleImmediately(boolean executeRuleImmediately)

Sets the values that indicates whether the rule should be executed immediately or not.

Parameters:

executeRuleImmediately - true execute the rule immediaely, false otherwise

registerRuleType

public void registerRuleType(RuleType ruleType)

Registration of an interested rule type

Specified by:

registerRuleType in interface RuleTrigger

Parameters:

ruleType - the rule type

triggerRules

protected void triggerRules(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                            org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)

Trigger the rules that relate to any interested rule types for the node references passed.

Parameters:

nodeRef - the node reference who rules are to be triggered

actionedUponNodeRef - the node reference that will be actioned upon by the rules

areRulesEnabled

protected boolean areRulesEnabled()

Helper method to allow triggers to check if rules are enabled or disabled (ALF-10839: Eliminate rule discovery overhead on property update when rules have been disabled)

Returns:

true if rules are enabled