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

Public Member Functions

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

Static Public Member Functions

static synchronized IngestServices getInstance ()

Private Member Functions

 IngestServices ()

Private Attributes

final IngestManager manager = IngestManager.getInstance()

Static Private Attributes

static IngestServices instance = null

Detailed Description

Singleton class that provides services for ingest modules. These exist to make it easier to write modules. Use the getDefault() method to get the singleton instance.

Definition at line 32 of file

Constructor & Destructor Documentation

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

Member Function Documentation

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

Fire module content event to notify registered module content event listeners that there is new content (from ZIP file contents, carving, etc.)

moduleContentEventmodule content event, encapsulating content changed

Definition at line 109 of file

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

Referenced by, and org.sleuthkit.autopsy.externalresults.ExternalResultsImporter.importDerivedFiles().

void org.sleuthkit.autopsy.ingest.IngestServices.fireModuleDataEvent ( ModuleDataEvent  moduleDataEvent)
String org.sleuthkit.autopsy.ingest.IngestServices.getConfigSetting ( String  moduleName,
String  settingName 

Gets a specific name/value configuration setting for a module

moduleNamemoduleName identifier unique to that module
settingNamesetting name to retrieve
setting value for the module / setting name, or null if not found

Definition at line 130 of file

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

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

Gets all name/value configuration settings for a module

moduleNamemoduleName identifier unique to that module
settings for the module / setting name

Definition at line 151 of file

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

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

Get the current Autopsy case.

The current case.

Definition at line 57 of file

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

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

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

The current case database.

Definition at line 66 of file

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

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

Get free disk space of a drive where ingest data are written to That drive is being monitored by IngestMonitor thread when ingest is running.

amount of disk space, -1 if unknown

Definition at line 119 of file

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

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

moduleClassNameThe display name of the ingest module.
The custom logger for the ingest module.

Definition at line 77 of file

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

Referenced by org.sleuthkit.autopsy.examples.SampleExecutableDataSourceIngestModule.process().

void org.sleuthkit.autopsy.ingest.IngestServices.postMessage ( final IngestMessage  message)
void org.sleuthkit.autopsy.ingest.IngestServices.setConfigSetting ( String  moduleName,
String  settingName,
String  settingVal 

Sets a specific name/value configuration setting for a module

moduleNamemoduleName identifier unique to that module
settingNamesetting name to set
settingValsetting value to set

Definition at line 141 of file

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

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

Sets all name/value configuration setting for a module. Names not in the list will have settings preserved.

moduleNamemoduleName identifier unique to that module
settingssettings to set and replace old settings, keeping settings not specified in the map.

Definition at line 164 of file

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

Member Data Documentation

IngestServices org.sleuthkit.autopsy.ingest.IngestServices.instance = null
final IngestManager org.sleuthkit.autopsy.ingest.IngestServices.manager = IngestManager.getInstance()

Definition at line 35 of file

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.