Package ai.nightfall.scan.model

Class ExclusionRule

java.lang.Object
ai.nightfall.scan.model.ExclusionRule
public class ExclusionRule extends Object
An object that describes a regular expression or list of keywords that may be used to disqualify a candidate finding from triggering a detector match.

  • Constructor Details

    • ExclusionRule

      public ExclusionRule(Regex regex, String matchType)
      Create an exclusion rule that uses a regular expression to make a disqualification decision.
      Parameters:
      regex - the regular expression
      matchType - the match type; valid values are FULL or PARTIAL

    • ExclusionRule

      public ExclusionRule(WordList wordList, String matchType)
      Create an exclusion rule that uses a word list to make a disqualification decision.
      Parameters:
      wordList - the word list
      matchType - the match type; valid values are FULL or PARTIAL

  • Method Details

    • getMatchType

      public String getMatchType()
      Get the match type.
      Returns:
      the match type represented by this exclusion rule. Valid values are PARTIAL or FULL.

    • getExclusionType

      public String getExclusionType()
      Get the exclusion type.
      Returns:
      the type of this exclusion rule. Valid values are WORD_LIST or REGEX. The corresponding field in this object must be set according to the value specified here.

    • getRegex

      public Regex getRegex()
      Get the regex.
      Returns:
      the regular expression to use to evaluate the exclusion rule

    • getWordList

      public WordList getWordList()
      Get the word list.
      Returns:
      the word list to use to evaluate the exclusion rule