All Classes and Interfaces
Class
Description
AbstractClue contains the @see WorkContextDelegate, @see NameMatchingDelegate, Name and
continueToRunIfDetected which are also common to all @see Clue references.
An implementation of @see Pattern that will serve most Pattern Detection needs
allAreRequiredClues - every @see Clue added to this list needs to be detected for
the @see Pattern to be considered detected onlyOneIsRequiredClues - only one @see Clue
from this list needs to be detected for the @see Pattern to be considered detected
If both onlyOneIsRequiredClues and allAreRequiredClues are configured, then all of
the @Clue in allAreRequiredClues must be detected AND one of the @see Clue in the
onlyOneIsRequiredClues must be detected
A Clue is a aspect of a file/folder that can be detected.
Throw if a @see Clue is being built that can never be detected (ie: missing any of the
basic criteria to scan for).
Implementation of a Clue that scans the contents of a file for specific strings.
Wrapper for the results of the Scan:
- Detected @see Pattern references (meaning all required @see Clue were discovered) - A
list of all the detected @see Clue and the files that triggered the detection.
Helper methods for working with Files and their contents.
Implementation of a Clue that scans the names of Files/Folder for text patterns.
Wraps the logic around file/folder name matching
Pattern is what the Scan is looking to Detect.
Thrown for any issue related to the parameters passed into the WorkContext to start the
scan
A catch-all thrown when issues occur during the execution of scans in the WorkFlow
Main entry point to the library
Provides access to the ThreadPool executor for all Scans to share.
Contains helper methods for working with the data in the WorkContext.
These are used to put things in the @see WorkContext - DESIRED_PATTERNS - Patterns we
are looking for - DETECTED_PATTERNS - As Patterns are found during scanning, they are
stored in the WorkContext using this key - START_DIRECTORY - Where to start scanning -
FILES_TO_SCAN - The files are folders contained in the START_DIRECTORY -
FOLDERS_TO_SCAN - All the folders contained in the START_DIRECTORY location
These are used to both PUT and GET from Context