Public Member Functions
void	fireModuleContentEvent (ModuleContentEvent moduleContentEvent)

void	fireModuleDataEvent (ModuleDataEvent moduleDataEvent)

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 settingVal)

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 IngestServices.java.

Constructor & Destructor Documentation

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

private

Definition at line 37 of file IngestServices.java.

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

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.)

Parameters

moduleContentEvent module content event, encapsulating content changed

Definition at line 110 of file IngestServices.java.

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

Referenced by org.sleuthkit.autopsy.casemodule.services.FileManager.addLocalFilesDataSource(), org.sleuthkit.autopsy.externalresults.ExternalResultsImporter.importDerivedFiles(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails().

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

Fire module data event to notify registered module data event listeners that there is new data of a given type from a module.

Parameters

moduleDataEvent module data event, encapsulating blackboard artifact data

Definition at line 98 of file IngestServices.java.

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

Referenced by org.sleuthkit.autopsy.externalresults.ExternalResultsImporter.importArtifacts(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postHashSetHitToBlackboard(), org.sleuthkit.autopsy.modules.exif.ExifParserFileIngestModule.process(), org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.process(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst(), and org.sleuthkit.autopsy.modules.exif.ExifParserFileIngestModule.shutDown().

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

Gets a specific name/value configuration setting for a module

Parameters

moduleName	moduleName identifier unique to that module
settingName	setting name to retrieve

Returns: setting value for the module / setting name, or null if not found

Definition at line 132 of file IngestServices.java.

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

Parameters

moduleName moduleName identifier unique to that module

Returns: settings for the module / setting name

Definition at line 154 of file IngestServices.java.

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

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

Get the current Autopsy case.

Returns: The current case.

Definition at line 57 of file IngestServices.java.

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.

Returns: The current case database.

Definition at line 66 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 ( )

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.

Returns: amount of disk space, -1 if unknown

Definition at line 120 of file IngestServices.java.

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

Get the ingest services.

Returns: The ingest services singleton.

Definition at line 45 of file IngestServices.java.

References org.sleuthkit.autopsy.ingest.IngestServices.IngestServices(), and org.sleuthkit.autopsy.ingest.IngestServices.instance.

Referenced by org.sleuthkit.autopsy.ingest.IngestMonitor.MonitorTimerAction.actionPerformed(), org.sleuthkit.autopsy.casemodule.services.FileManager.addLocalFilesDataSource(), org.sleuthkit.autopsy.externalresults.ExternalResultsImporter.importArtifacts(), org.sleuthkit.autopsy.externalresults.ExternalResultsImporter.importDerivedFiles(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postSummary(), org.sleuthkit.autopsy.examples.SampleExecutableDataSourceIngestModule.process(), and org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.shutDown().

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.

Parameters

moduleDisplayName The display name of the ingest module.

Returns: The custom logger for the ingest module.

Definition at line 78 of file IngestServices.java.

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 )

Post message to the ingest messages in box.

Parameters

message An ingest message

Definition at line 87 of file IngestServices.java.

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

Sets a specific name/value configuration setting for a module

Parameters

moduleName	moduleName identifier unique to that module
settingName	setting name to set
settingVal	setting value to set

Definition at line 143 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 name/value configuration setting for a module. Names not in the list will have settings preserved.

Parameters

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

Definition at line 167 of file IngestServices.java.

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

Member Data Documentation

IngestServices org.sleuthkit.autopsy.ingest.IngestServices.instance = null

staticprivate

Definition at line 34 of file IngestServices.java.

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

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

private

Definition at line 35 of file IngestServices.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/ingest/IngestServices.java

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation