org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager Class Reference

Public Member Functions
synchronized RuleSet	createRuleSet (String name) throws RuleSetException
synchronized void	deleteRuleSet (RuleSet ruleSet) throws RuleSetException
synchronized List< RuleSet >	getRuleSetList ()
synchronized boolean	isRuleSetExists (String name)
void	removePropertyChangeListener (PropertyChangeListener listener)

Static Public Member Functions
static void	addPropertyChangeListener (PropertyChangeListener listener)
static synchronized RuleSetManager	getInstance ()

Static Public Attributes
static final String	RULE_SET_ADDED = "YARARuleSetAdded"
static final String	RULE_SET_DELETED = "YARARuleSetDeleted"

Private Member Functions
	RuleSetManager ()
boolean	deleteDirectory (File directoryToBeDeleted)
PropertyChangeSupport	getChangeSupport ()
Path	getRuleSetPath ()

Private Attributes
final PropertyChangeSupport	changeSupport

Static Private Attributes
static final String	BASE_FOLDER = "yara"
static RuleSetManager	instance
static final String	RULE_SET_FOLDER = "ruleSets"

Detailed Description

Yara Rule Set Manager. Manages the creation, deletion of yara rule sets.

Definition at line 35 of file RuleSetManager.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.RuleSetManager ( )

private

Private constructor for this singleton.

Definition at line 53 of file RuleSetManager.java.

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getInstance().

Member Function Documentation

static void org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.addPropertyChangeListener ( PropertyChangeListener  listener )

static

Adds a property change listener to the manager.

Parameters

listener

Listener to be added.

Definition at line 75 of file RuleSetManager.java.

References org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getChangeSupport(), and org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getInstance().

Referenced by org.sleuthkit.autopsy.modules.yara.ui.YaraIngestSettingsPanel.YaraIngestSettingsPanel().

synchronized RuleSet org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.createRuleSet

(

String

name

)

throws RuleSetException

Create a new Yara rule set with the given set name.

Parameters

name	Name of new rule set

Returns

Newly created RuleSet

Exceptions

RuleSetException

RuleSet with given name already exists.

Definition at line 97 of file RuleSetManager.java.

References org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getChangeSupport(), org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getRuleSetPath(), and org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.isRuleSetExists().

Referenced by org.sleuthkit.autopsy.modules.yara.ui.YaraRuleSetOptionPanel.handleNewRuleSet().

boolean org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.deleteDirectory ( File  directoryToBeDeleted )

private

Recursively delete the given directory and its children.

Parameters

directoryToBeDeleted

Returns

True if the delete was successful.

Definition at line 214 of file RuleSetManager.java.

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.deleteRuleSet().

synchronized void org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.deleteRuleSet

(

RuleSet

ruleSet

)

throws RuleSetException

Deletes an existing RuleSet.

Parameters

ruleSet

RuleSet to be deleted.

Exceptions

RuleSetException

Definition at line 130 of file RuleSetManager.java.

References org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.deleteDirectory(), org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getChangeSupport(), and org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.isRuleSetExists().

Referenced by org.sleuthkit.autopsy.modules.yara.ui.YaraRuleSetOptionPanel.handleDeleteRuleSet().

PropertyChangeSupport org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getChangeSupport ( )

private

Returns the PropertyChangeSupport instance.

Returns

PropertyChangeSupport instance.

Definition at line 203 of file RuleSetManager.java.

References org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.changeSupport.

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.addPropertyChangeListener(), org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.createRuleSet(), org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.deleteRuleSet(), and org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.removePropertyChangeListener().

static synchronized RuleSetManager org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getInstance ( )

static

Returns the instance of this manager class.

Returns

Definition at line 62 of file RuleSetManager.java.

References org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.instance, and org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.RuleSetManager().

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.addPropertyChangeListener(), org.sleuthkit.autopsy.modules.yara.ui.YaraRuleSetOptionPanel.handleDeleteRuleSet(), org.sleuthkit.autopsy.modules.yara.ui.YaraRuleSetOptionPanel.handleNewRuleSet(), org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.removePropertyChangeListener(), and org.sleuthkit.autopsy.modules.yara.ui.YaraIngestSettingsPanel.YaraIngestSettingsPanel().

synchronized List<RuleSet> org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getRuleSetList

(

)

Returns a list of all of the existing yara rule sets.

Returns

Definition at line 154 of file RuleSetManager.java.

References org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getRuleSetPath().

Referenced by org.sleuthkit.autopsy.modules.yara.ui.YaraIngestSettingsPanel.YaraIngestSettingsPanel().

Path org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getRuleSetPath ( )

private

Returns the Path to get RuleSet directory. If it does not exist it is created.

Returns

Yara rule set directory path.

Definition at line 187 of file RuleSetManager.java.

References org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.BASE_FOLDER, org.sleuthkit.autopsy.coreutils.PlatformUtil.getUserDirectory(), and org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.RULE_SET_FOLDER.

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.createRuleSet(), org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getRuleSetList(), and org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.isRuleSetExists().

synchronized boolean org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.isRuleSetExists

(

String

name

)

Check if a yara rule set of the given name exists.

Parameters

name	Yara rule set name

Returns

True if the rule set exist.

Definition at line 174 of file RuleSetManager.java.

References org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getRuleSetPath().

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.createRuleSet(), and org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.deleteRuleSet().

void org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.removePropertyChangeListener

(

PropertyChangeListener

listener

)

Remove a property change listener from this manager.

Parameters

listener

Listener to be added.

Definition at line 84 of file RuleSetManager.java.

References org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getChangeSupport(), and org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getInstance().

Member Data Documentation

final String org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.BASE_FOLDER = "yara"

staticprivate

Definition at line 37 of file RuleSetManager.java.

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getRuleSetPath().

final PropertyChangeSupport org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.changeSupport

private

Definition at line 46 of file RuleSetManager.java.

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getChangeSupport().

RuleSetManager org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.instance

staticprivate

Definition at line 48 of file RuleSetManager.java.

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getInstance().

final String org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.RULE_SET_ADDED = "YARARuleSetAdded"

static

Rule Set Property names.

Definition at line 43 of file RuleSetManager.java.

Referenced by org.sleuthkit.autopsy.modules.yara.ui.YaraIngestSettingsPanel.YaraIngestSettingsPanel().

final String org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.RULE_SET_DELETED = "YARARuleSetDeleted"

static

Definition at line 44 of file RuleSetManager.java.

Referenced by org.sleuthkit.autopsy.modules.yara.ui.YaraIngestSettingsPanel.YaraIngestSettingsPanel().

final String org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.RULE_SET_FOLDER = "ruleSets"

staticprivate

Definition at line 38 of file RuleSetManager.java.

Referenced by org.sleuthkit.autopsy.modules.yara.rules.RuleSetManager.getRuleSetPath().

---

The documentation for this class was generated from the following file:

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/modules/yara/rules/RuleSetManager.java