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

Public Member Functions

void fireModuleContentEvent (ModuleContentEvent moduleContentEvent)
 
void fireModuleDataEvent (ModuleDataEvent moduleDataEvent)
 
Case getCase () throws NoCurrentCaseException
 
SleuthkitCase getCaseDatabase () throws NoCurrentCaseException
 
String getConfigSetting (String moduleName, String settingName)
 
Map< String, String > getConfigSettings (String moduleName)
 
Case getCurrentCase ()
 
SleuthkitCase getCurrentSleuthkitCaseDb ()
 
long getFreeDiskSpace ()
 
Logger getLogger (String moduleDisplayName)
 
void postMessage (final IngestMessage message)
 
void setConfigSetting (String moduleName, String settingName, String setting)
 
void setConfigSettings (String moduleName, Map< String, String > settings)
 

Static Public Member Functions

static synchronized IngestServices getInstance ()
 

Private Member Functions

 IngestServices ()
 

Static Private Attributes

static IngestServices instance = null
 
static Logger logger = Logger.getLogger(IngestServices.class.getName())
 

Detailed Description

Ingest services provides convenience methods for ingest modules to use during to access the Autopsy case, the case database, fire events, etc.

Definition at line 34 of file IngestServices.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.IngestServices.IngestServices ( )
private

Constructs an ingest services object that provides convenience methods for ingest modules to use to access the Autopsy case, the case database, fire events, etc.

Definition at line 44 of file IngestServices.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestServices.getInstance().

Member Function Documentation

void org.sleuthkit.autopsy.ingest.IngestServices.fireModuleContentEvent ( ModuleContentEvent  moduleContentEvent)

Fires an event to notify registered listeners that there is new content added to the case. (e.g., files extracted from an archive file, carved files, etc.)

Parameters
moduleContentEventA module content event, i.e., an event that encapsulates new content data.

Definition at line 132 of file IngestServices.java.

References org.sleuthkit.autopsy.ingest.IngestManager.getInstance().

Referenced by org.sleuthkit.autopsy.casemodule.services.FileManager.addLocalFilesDataSource(), org.sleuthkit.autopsy.modules.pictureanalyzer.impls.HEICProcessor.convertToJPEG(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEMLFile().

void org.sleuthkit.autopsy.ingest.IngestServices.fireModuleDataEvent ( ModuleDataEvent  moduleDataEvent)

Fires an event to notify registered listeners that a new artifact has been posted to the blackboard.

Parameters
moduleDataEventA module data event, i.e., an event that encapsulates artifact data.
Deprecated:
Use org.sleuthkit.datamodel.Blackboard.postArtifact or org.sleuthkit.datamodel.Blackboard.postArtifacts instead.

Definition at line 115 of file IngestServices.java.

References org.sleuthkit.autopsy.ingest.ModuleDataEvent.getArtifacts(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.ingest.ModuleDataEvent.getModuleName(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

Case org.sleuthkit.autopsy.ingest.IngestServices.getCase ( ) throws NoCurrentCaseException

Gets the current open Autopsy case.

Returns
The current open case.
Exceptions
NoCurrentCaseExceptionif there is no open case.

Definition at line 68 of file IngestServices.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows().

SleuthkitCase org.sleuthkit.autopsy.ingest.IngestServices.getCaseDatabase ( ) throws NoCurrentCaseException

Gets the case database of the current open Autopsy case.

Returns
The current case database.
Exceptions
NoCurrentCaseExceptionif there is no open case.

Definition at line 79 of file IngestServices.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

String org.sleuthkit.autopsy.ingest.IngestServices.getConfigSetting ( String  moduleName,
String  settingName 
)

Gets a global configuration setting for an ingest module.

Parameters
moduleNameA unique identifier for the module.
settingNameThe name of the setting.
Returns
setting The value of the setting, or null if not found.

Definition at line 155 of file IngestServices.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting().

Map<String, String> org.sleuthkit.autopsy.ingest.IngestServices.getConfigSettings ( String  moduleName)

Gets all of the global configuration settings for an ingest module.

Parameters
moduleNameA unique identifier for the module.
Returns
A mapping of setting names to setting values.

Definition at line 177 of file IngestServices.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSettings().

Case org.sleuthkit.autopsy.ingest.IngestServices.getCurrentCase ( )

Get the current open case.

Returns
The current case.
Deprecated:
Use getCase instead.

Definition at line 211 of file IngestServices.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCase().

SleuthkitCase org.sleuthkit.autopsy.ingest.IngestServices.getCurrentSleuthkitCaseDb ( )

Gets the current SleuthKit case. The SleuthKit case is the case database.

Returns
The current case database.
Deprecated:
Use getCaseDatabase instead.

Definition at line 199 of file IngestServices.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

long org.sleuthkit.autopsy.ingest.IngestServices.getFreeDiskSpace ( )

Gets the free disk space of the drive where data is written during ingest. Can be used by ingest modules to determine if there is enough disk space before writing data is attmepted.

Returns
Amount of free disk space, in bytes, or -1 if unknown.

Definition at line 143 of file IngestServices.java.

References org.sleuthkit.autopsy.ingest.IngestManager.getInstance().

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processMBox(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst().

static synchronized IngestServices org.sleuthkit.autopsy.ingest.IngestServices.getInstance ( )
static
Logger org.sleuthkit.autopsy.ingest.IngestServices.getLogger ( String  moduleDisplayName)

Gets a logger that incorporates the display name of an ingest module in messages written to the Autopsy log files.

Parameters
moduleDisplayNameThe display name of the ingest module.
Returns
A logger for the ingest module.

Definition at line 91 of file IngestServices.java.

References org.sleuthkit.autopsy.coreutils.Logger.getLogger().

void org.sleuthkit.autopsy.ingest.IngestServices.postMessage ( final IngestMessage  message)

Posts a message to the ingest messages in box.

Parameters
messageAn ingest message

Definition at line 100 of file IngestServices.java.

References org.sleuthkit.autopsy.ingest.IngestManager.getInstance().

Referenced by org.sleuthkit.autopsy.ingest.IngestMonitor.MonitorTimerAction.actionPerformed(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.createArtifactIfNotExists(), org.sleuthkit.autopsy.modules.embeddedfileextractor.ExtractArchiveWithPasswordAction.ExtractAndIngestWorker.doInBackground(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postHashSetHitToBlackboard(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.postIndexSummary(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postSummary(), org.sleuthkit.autopsy.modules.drones.DroneIngestModule.process(), org.sleuthkit.autopsy.modules.dataSourceIntegrity.DataSourceIntegrityIngestModule.process(), org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.process(), org.sleuthkit.autopsy.modules.leappanalyzers.ILeappAnalyzerIngestModule.process(), org.sleuthkit.autopsy.modules.leappanalyzers.ALeappAnalyzerIngestModule.process(), org.sleuthkit.autopsy.modules.plaso.PlasoIngestModule.process(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.process(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.reportLookupError(), org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.shutDown(), org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.shutDown(), org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.shutDown(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.startUp(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

void org.sleuthkit.autopsy.ingest.IngestServices.setConfigSetting ( String  moduleName,
String  settingName,
String  setting 
)

Sets a global configuration setting for an ingest module.

Parameters
moduleNameA unique identifier for the module.
settingNameThe name of the setting.
settingThe value of the setting.

Definition at line 166 of file IngestServices.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

void org.sleuthkit.autopsy.ingest.IngestServices.setConfigSettings ( String  moduleName,
Map< String, String >  settings 
)

Sets all of the global configuration settings for an ingest module.

Parameters
moduleNameA unique identifier for the module.
settingsA mapping of setting names to setting values.

Definition at line 187 of file IngestServices.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSettings().

Member Data Documentation

IngestServices org.sleuthkit.autopsy.ingest.IngestServices.instance = null
staticprivate
Logger org.sleuthkit.autopsy.ingest.IngestServices.logger = Logger.getLogger(IngestServices.class.getName())
staticprivate

Definition at line 36 of file IngestServices.java.


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

Copyright © 2012-2021 Basis Technology. Generated on: Fri Aug 6 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.