Class AbstractPropertyEnforcerRule

All Implemented Interfaces:
EnforcerRule, EnforcerRule2
Direct Known Subclasses:
RequireEnvironmentVariable, RequireProperty

public abstract class AbstractPropertyEnforcerRule extends AbstractNonCacheableEnforcerRule
Abstract enforcer rule that give a foundation to validate properties from multiple sources.
Version:
$Id: AbstractPropertyEnforcerRule.java 1697215 2015-08-23 16:27:17Z khmarbaise $
  • Field Details

    • regex

      private String regex
      Match the property value to a given regular expression. Defaults to null (any value is ok).
    • regexMessage

      private String regexMessage
      Specify a warning message if the regular expression is not matched.
  • Constructor Details

    • AbstractPropertyEnforcerRule

      public AbstractPropertyEnforcerRule()
  • Method Details

    • setRegex

      public final void setRegex(String regex)
      Set the property value to a given regular expression. Defaults to null (any value is ok).
      Parameters:
      regex - The regular expression
    • getRegex

      public final String getRegex()
      Get the property value to a given regular expression. Defaults to null (any value is ok).
      Returns:
      the regular expression
    • setRegexMessage

      public final void setRegexMessage(String regexMessage)
      Set a warning message if the regular expression is not matched.
      Parameters:
      regexMessage - the regex message
    • getRegexMessage

      public final String getRegexMessage()
      Get a warning message if the regular expression is not matched.
      Returns:
      the regex message
    • execute

      public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException
      Execute the rule.
      Parameters:
      helper - the helper
      Throws:
      EnforcerRuleException - the enforcer rule exception
    • getName

      public abstract String getName()
      How the property that is being evaluated is called
    • getPropertyName

      public abstract String getPropertyName()
      The name of the property currently being evaluated, this is used for default message pourpouses only
    • resolveValue

      public abstract Object resolveValue(EnforcerRuleHelper helper) throws EnforcerRuleException
      Resolves the property value
      Parameters:
      helper -
      Throws:
      EnforcerRuleException