Autopsy  4.19.3
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, BlackboardArtifact.Type blackboardArtifactType)
 
 ModuleDataEvent (String moduleName, BlackboardArtifact.Type blackboardArtifactType, Collection< BlackboardArtifact > artifacts)
 
 ModuleDataEvent (String moduleName, ARTIFACT_TYPE artifactType, Collection< BlackboardArtifact > artifacts)
 
Collection< BlackboardArtifact > getArtifacts ()
 
ARTIFACT_TYPE getArtifactType ()
 
BlackboardArtifact.Type getBlackboardArtifactType ()
 
String getModuleName ()
 

Private Attributes

Collection< BlackboardArtifact > artifacts
 
BlackboardArtifact.Type blackboardArtifactType
 
String moduleName
 

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 49 of file ModuleDataEvent.java.

Constructor & Destructor Documentation

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

Definition at line 59 of file ModuleDataEvent.java.

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

org.sleuthkit.autopsy.ingest.ModuleDataEvent.ModuleDataEvent ( String  moduleName,
BlackboardArtifact.Type  blackboardArtifactType 
)
Parameters
moduleNameModule Name
blackboardArtifactTypeType of the blackboard artifact posted to the blackboard

Definition at line 70 of file ModuleDataEvent.java.

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

org.sleuthkit.autopsy.ingest.ModuleDataEvent.ModuleDataEvent ( String  moduleName,
BlackboardArtifact.Type  blackboardArtifactType,
Collection< BlackboardArtifact >  artifacts 
)
Parameters
moduleNameModule name
blackboardArtifactTypeType of artifact posted to the blackboard
artifactsList of specific artifact ID values that were added to blackboard

Definition at line 82 of file ModuleDataEvent.java.

References org.sleuthkit.autopsy.ingest.ModuleDataEvent.artifacts, org.sleuthkit.autopsy.ingest.ModuleDataEvent.blackboardArtifactType, and org.sleuthkit.autopsy.ingest.ModuleDataEvent.moduleName.

org.sleuthkit.autopsy.ingest.ModuleDataEvent.ModuleDataEvent ( String  moduleName,
ARTIFACT_TYPE  artifactType,
Collection< BlackboardArtifact >  artifacts 
)
Parameters
moduleNameModule name
artifactTypeType of artifact that was posted to blackboard
artifactsList of specific artifact values that were added to blackboard

Definition at line 93 of file ModuleDataEvent.java.

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

Member Function Documentation

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

get artifact type of the new artifacts associated with the event

Exceptions
IllegalArgumentExceptionif the type is user defined
Returns
the artifact type

Definition at line 124 of file ModuleDataEvent.java.

References org.sleuthkit.autopsy.ingest.ModuleDataEvent.blackboardArtifactType.

BlackboardArtifact.Type org.sleuthkit.autopsy.ingest.ModuleDataEvent.getBlackboardArtifactType ( )
String org.sleuthkit.autopsy.ingest.ModuleDataEvent.getModuleName ( )

Member Data Documentation

Collection<BlackboardArtifact> org.sleuthkit.autopsy.ingest.ModuleDataEvent.artifacts
private
BlackboardArtifact.Type org.sleuthkit.autopsy.ingest.ModuleDataEvent.blackboardArtifactType
private
String org.sleuthkit.autopsy.ingest.ModuleDataEvent.moduleName
private

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

Copyright © 2012-2022 Basis Technology. Generated on: Sat Sep 24 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.