Autopsy  3.1
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.ingest.ModuleDataEvent Class Reference

Inherits ChangeEvent.

Public Member Functions

 ModuleDataEvent (String moduleName, ARTIFACT_TYPE artifactType)
 ModuleDataEvent (String moduleName, ARTIFACT_TYPE artifactType, Collection< BlackboardArtifact > artifactIDs)
Collection< BlackboardArtifactgetArtifacts ()
ARTIFACT_TYPE getArtifactType ()
String getModuleName ()

Private Attributes

String moduleName
ARTIFACT_TYPE artifactType
Collection< BlackboardArtifactartifactIDs

Detailed Description

Event data that are fired off by ingest modules when they have posted new data of specific type to the blackboard. The name of property change fired is then IngestManager.IngestModuleEvent.DATA.toString()

In its most generic form, it only gives notice about a type of artifact and it can also give notice about specific IDs that can be retrieved.

The object wraps a collection of blackboard artifacts and their associated attributes that are to be reported as the new data to listeners. Passing the data as part of the event reduces memory footprint and decreases number of garbage collections of the blackboard artifacts and attributes objects (the objects are expected to be reused by the data event listeners).

If a module does not pass the data as part of ModuleDataEvent (ModuleDataEvent.getArtifacts() returns null) - it is an indication that the module has new data but it does not implement new data tracking. The listener can then perform a blackboard query to get the latest data of interest (e.g. by artifact type).

By design, only a single type of artifacts can be contained in a single data event.

Definition at line 41 of file

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.ModuleDataEvent.ModuleDataEvent ( String  moduleName,
ARTIFACT_TYPE  artifactType 
moduleNameModule name
artifactTypeType of artifact that was posted to blackboard

Definition at line 52 of file

References org.sleuthkit.autopsy.ingest.ModuleDataEvent.artifactType, and org.sleuthkit.autopsy.ingest.ModuleDataEvent.moduleName.

org.sleuthkit.autopsy.ingest.ModuleDataEvent.ModuleDataEvent ( String  moduleName,
ARTIFACT_TYPE  artifactType,
Collection< BlackboardArtifact artifactIDs 
moduleNameModule name
artifactTypeType of artifact that was posted to blackboard
artifactIDsList of specific artifact ID values that were added to blackboard

Definition at line 63 of file

References org.sleuthkit.autopsy.ingest.ModuleDataEvent.artifactIDs, org.sleuthkit.autopsy.ingest.ModuleDataEvent.artifactType, and org.sleuthkit.autopsy.ingest.ModuleDataEvent.moduleName.

Member Function Documentation

Collection<BlackboardArtifact> org.sleuthkit.autopsy.ingest.ModuleDataEvent.getArtifacts ( )

get new artifact IDs associated with the event

Collection of artifact ids or null if not provided

Definition at line 72 of file

References org.sleuthkit.autopsy.ingest.ModuleDataEvent.artifactIDs.

ARTIFACT_TYPE org.sleuthkit.autopsy.ingest.ModuleDataEvent.getArtifactType ( )

get artifact type of the new artifacts associated with the event


Definition at line 80 of file

References org.sleuthkit.autopsy.ingest.ModuleDataEvent.artifactType.

String org.sleuthkit.autopsy.ingest.ModuleDataEvent.getModuleName ( )

get module name that created the artifacts and fired the event


Definition at line 88 of file

References org.sleuthkit.autopsy.ingest.ModuleDataEvent.moduleName.

Member Data Documentation

Collection<BlackboardArtifact> org.sleuthkit.autopsy.ingest.ModuleDataEvent.artifactIDs
ARTIFACT_TYPE org.sleuthkit.autopsy.ingest.ModuleDataEvent.artifactType
String org.sleuthkit.autopsy.ingest.ModuleDataEvent.moduleName

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

Copyright © 2012-2015 Basis Technology. Generated on: Mon Oct 19 2015
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.