Package 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, OnCreateChildAssociationRuleTrigger, OnMoveNodeRuleTrigger, OnPropertyUpdateRuleTrigger, RestoreNodeRuleTrigger, SingleAssocRefPolicyRuleTrigger, SingleNodeRefPolicyRuleTrigger
public abstract class RuleTriggerAbstractBase extends Object implements RuleTrigger
Rule trigger abstract base
Author:
Roy Wetherall

  • Field Details

    • policyComponent

      protected PolicyComponent policyComponent

    • nodeService

      protected NodeService nodeService

    • contentService

      protected ContentService contentService

    • authenticationComponent

      protected AuthenticationComponent authenticationComponent

    • dictionaryService

      protected 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 Details

    • RuleTriggerAbstractBase

      public RuleTriggerAbstractBase()

  • Method Details

    • setPolicyComponent

      public void setPolicyComponent(PolicyComponent policyComponent)
      Set the policy component

    • setNodeService

      public void setNodeService(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(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(NodeRef nodeRef, 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

    • ignoreTrigger

      protected boolean ignoreTrigger(NodeRef actionedUponNodeRef)
      Indicate whether the trigger should be ignored or not
      Parameters:
      actionedUponNodeRef - actioned upon node reference
      Returns:
      boolean true if the trigger should be ignored, false otherwise

    • getIgnoredAspects

      public Set<QName> getIgnoredAspects()

    • setIgnoredAspectsStr

      public void setIgnoredAspectsStr(List<String> ignoredAspects)
      Converting String Aspects from Spring context to QNames
      Parameters:
      ignoredAspects - List of ignoredAspects

    • getIgnoredTypes

      public Set<QName> getIgnoredTypes()

    • setIgnoredTypeStr

      public void setIgnoredTypeStr(List<String> ignoredTypes)
      Converting String ignored Types from Spring context to QNames
      Parameters:
      ignoredTypes -