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

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 32 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 41 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

moduleContentEvent A module content event, i.e., an event that encapsulates new content data.

Definition at line 124 of file IngestServices.java.

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

Referenced by org.sleuthkit.autopsy.casemodule.services.FileManager.addLocalFilesDataSource(), 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

moduleDataEvent A module data event, i.e., an event that encapsulates artifact data.

Deprecated:: use org.sleuthkit.datamodel.Blackboard.postArtifact instead.

Definition at line 111 of file IngestServices.java.

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

Referenced by org.sleuthkit.autopsy.casemodule.Case.TSKCaseRepublisher.rebroadcastArtifactsPosted().

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

Gets the current open Autopsy case.

Returns: The current open case.

Exceptions

NoCurrentCaseException if there is no open case.

Definition at line 65 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

NoCurrentCaseException if there is no open case.

Definition at line 76 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

moduleName	A unique identifier for the module.
settingName	The name of the setting.

Returns: setting The value of the setting, or null if not found.

Definition at line 147 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

moduleName A unique identifier for the module.

Returns: A mapping of setting names to setting values.

Definition at line 169 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 203 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 191 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 135 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

Gets the ingest services singleton that provides convenience methods for ingest modules to use to access the Autopsy case, the case database, fire events,

Returns: The ingest services singleton.

Definition at line 51 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.modules.embeddedfileextractor.ExtractArchiveWithPasswordAction.ExtractAndIngestWorker.doInBackground(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postSummary(), org.sleuthkit.autopsy.modules.plaso.PlasoIngestModule.process(), org.sleuthkit.autopsy.casemodule.Case.TSKCaseRepublisher.rebroadcastArtifactsPosted(), and org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.shutDown().

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

moduleDisplayName The display name of the ingest module.

Returns: A logger for the ingest module.

Definition at line 88 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

message An ingest message

Definition at line 97 of file IngestServices.java.

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

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

Sets a global configuration setting for an ingest module.

Parameters

moduleName	A unique identifier for the module.
settingName	The name of the setting.
setting	The value of the setting.

Definition at line 158 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

moduleName	A unique identifier for the module.
settings	A mapping of setting names to setting values.

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

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

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation