Package edu.internet2.middleware.grouper.rules

Enum Class RuleCheckType

java.lang.Object
java.lang.Enum<RuleCheckType>
edu.internet2.middleware.grouper.rules.RuleCheckType
All Implemented Interfaces:
Serializable, Comparable<RuleCheckType>, Constable
public enum RuleCheckType extends Enum<RuleCheckType>
type of checking for rules

  • Enum Constant Details

    • permissionDisabledDate

      public static final RuleCheckType permissionDisabledDate
      query daily for permissions that are enabled, but have a disabled date coming up

    • membershipDisabledDate

      public static final RuleCheckType membershipDisabledDate
      query daily for memberships that are enabled, but have a disabled date coming up

    • flattenedMembershipAddInFolder

      public static final RuleCheckType flattenedMembershipAddInFolder
      if there is a membership(flattened) add of a group in a stem

    • flattenedMembershipRemoveInFolder

      public static final RuleCheckType flattenedMembershipRemoveInFolder
      if there is a membership(flattened) remove of a group in a stem

    • flattenedMembershipRemove

      public static final RuleCheckType flattenedMembershipRemove
      if there is a membership remove flattened

    • membershipRemove

      public static final RuleCheckType membershipRemove
      if there is a membership remove in transaction of remove

    • membershipRemoveInFolder

      public static final RuleCheckType membershipRemoveInFolder
      if there is a membership remove in transaction of remove of a group in a stem

    • groupCreate

      public static final RuleCheckType groupCreate
      if a group is created

    • stemCreate

      public static final RuleCheckType stemCreate
      if a stem is created

    • membershipAdd

      public static final RuleCheckType membershipAdd
      if there is a membership add in transaction

    • subjectAssignInStem

      public static final RuleCheckType subjectAssignInStem
      if there is a membership add, privilege add, permission add, etc in transaction

    • flattenedMembershipAdd

      public static final RuleCheckType flattenedMembershipAdd
      if there is a membership remove flattened

    • membershipAddInFolder

      public static final RuleCheckType membershipAddInFolder
      if there is a membership remove in transaction of remove of a group in a stem

    • attributeDefCreate

      public static final RuleCheckType attributeDefCreate
      if a group is created

    • permissionAssignToSubject

      public static final RuleCheckType permissionAssignToSubject
      if there is a permission assign in transaction to a subject, not to a role

  • Method Details

    • values

      public static RuleCheckType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RuleCheckType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • usesArg0

      public abstract boolean usesArg0()

    • usesArg1

      public abstract boolean usesArg1()

    • checkKey

      public RuleCheck checkKey(RuleDefinition ruleDefinition)
      get the check key for the index
      Parameters:
      ruleDefinition -
      Returns:
      the rule check for the index

    • validate

      public abstract String validate(RuleDefinition ruleDefinition, RuleCheck ruleCheck)
      validate this check type
      Parameters:
      ruleDefinition -
      ruleCheck -
      Returns:
      the error or null if valid

    • ruleDefinitions

      public abstract Set<RuleDefinition> ruleDefinitions(RuleEngine ruleEngine, RulesBean rulesBean)
      get the check object from the rules bean
      Parameters:
      ruleEngine -
      rulesBean -
      Returns:
      the rules

    • addElVariables

      public abstract void addElVariables(RuleDefinition ruleDefinition, Map<String,Object> variableMap, RulesBean rulesBean, boolean hasAccessToElApi)
      add EL variables to the substitute map
      Parameters:
      ruleDefinition -
      variableMap -
      rulesBean -
      hasAccessToElApi -

    • isCheckOwnerTypeGroup

      public abstract boolean isCheckOwnerTypeGroup(RuleDefinition ruleDefinition)
      Whether or not the rule check owner type is a group
      Parameters:
      ruleDefinition -
      Returns:
      true if check owner type is a group

    • isCheckOwnerTypeStem

      public abstract boolean isCheckOwnerTypeStem(RuleDefinition ruleDefinition)
      Whether or not the rule check owner type is a stem
      Parameters:
      ruleDefinition -
      Returns:
      true if check owner type is a stem

    • isCheckOwnerTypeAttributeDef

      public abstract boolean isCheckOwnerTypeAttributeDef(RuleDefinition ruleDefinition)
      Whether or not the rule check owner type is an attribute def
      Parameters:
      ruleDefinition -
      Returns:
      true if check owner type is an attribute def

    • validate

      public String validate(boolean allowCheckArgs, RuleDefinition ruleDefinition, RuleCheck ruleCheck, boolean requireStemScope, boolean ownerIsGroup, boolean ownerIsStem, boolean ownerIsAttributeDef)
      validate this check type
      Parameters:
      allowCheckArgs -
      ruleDefinition -
      ruleCheck -
      requireStemScope - true to require, false to require blank
      ownerIsGroup -
      ownerIsStem -
      ownerIsAttributeDef -
      Returns:
      the error or null if valid

    • valueOfIgnoreCase

      public static RuleCheckType valueOfIgnoreCase(String string, boolean exceptionOnNull)
      do a case-insensitive matching
      Parameters:
      string -
      exceptionOnNull - will not allow null or blank entries
      Returns:
      the enum or null or exception if not found

    • runDaemon

      public void runDaemon(RuleDefinition ruleDefinition)
      run the daemon to sync up the state
      Parameters:
      ruleDefinition -

    • canRunDeamon

      public abstract boolean canRunDeamon(RuleDefinition ruleDefinition)

    • checkKeyForStem

      public static RuleCheck checkKeyForStem(RuleDefinition ruleDefinition)
      Parameters:
      ruleDefinition -
      Returns:
      rule check

    • checkKeyForAttributeDefinition

      public static RuleCheck checkKeyForAttributeDefinition(RuleDefinition ruleDefinition)
      Parameters:
      ruleDefinition -
      Returns:
      rule check

    • getOwnerType

      public abstract RuleOwnerType getOwnerType()