Classes
enum	IngestType

Public Member Functions
	IngestJobSettings (final String executionContext)

	IngestJobSettings (String executionContext, IngestType ingestType)

	IngestJobSettings (String executionContext, IngestType ingestType, Collection< IngestModuleTemplate > moduleTemplates)

	IngestJobSettings (String executionContext, IngestType ingestType, Collection< IngestModuleTemplate > moduleTemplates, FilesSet fileFilter)

List< IngestModuleTemplate >	getEnabledIngestModuleTemplates ()

String	getExecutionContext ()

FilesSet	getFileFilter ()

List< IngestModuleTemplate >	getIngestModuleTemplates ()

boolean	getProcessUnallocatedSpace ()

Path	getSavedModuleSettingsFolder ()

List< String >	getWarnings ()

void	save ()

void	saveAs (String executionContext)

void	setFileFilter (FilesSet fileIngestFilter)

void	setIngestModuleTemplates (List< IngestModuleTemplate > moduleTemplates)

Private Member Functions
void	createSavedModuleSettingsFolder ()

String	getModuleSettingsFilePath (IngestModuleFactory factory)

boolean	isPythonModuleSettingsFile (String moduleSettingsFilePath)

void	load ()

IngestModuleIngestJobSettings	loadModuleSettings (IngestModuleFactory factory)

void	saveModuleSettings (IngestModuleFactory factory, IngestModuleIngestJobSettings settings)

void	store ()

Static Private Member Functions
static HashSet< String >	getModulesNames (String executionContext, String propertyName, String defaultSetting)

static String	makeCsvList (Collection< String > collection)

Private Attributes
String	executionContext

FilesSet	fileFilter

final IngestType	ingestType

String	moduleSettingsFolderPath

final List< IngestModuleTemplate >	moduleTemplates = new ArrayList<>()

final List< String >	warnings = new ArrayList<>()

Static Private Attributes
static final String	DISABLED_MODULES_PROPERTY = "Disabled_Ingest_Modules"

static final String	ENABLED_MODULES_PROPERTY = "Enabled_Ingest_Modules"

static final String	LAST_FILE_INGEST_FILTER_PROPERTY = "Last_File_Ingest_Filter"

static final Logger	logger = Logger.getLogger(IngestJobSettings.class.getName())

static final String	MODULE_SETTINGS_FILE_EXT = ".settings"

static final String	MODULE_SETTINGS_FOLDER

static final String	MODULE_SETTINGS_FOLDER_NAME = "IngestSettings"

static final String	MODULE_SETTINGS_FOLDER_PATH

static final CharSequence	PYTHON_CLASS_PROXY_PREFIX = "org.python.proxies.".subSequence(0, "org.python.proxies.".length() - 1)

Detailed Description

The settings for an ingest job.

Definition at line 49 of file IngestJobSettings.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings ( final String executionContext )

Loads the ingest job settings for a given execution context. If settings for the context have not been previously saved, default settings are used.

Some examples of execution contexts include the Add Data Source wizard, the Run Ingest Modules dialog, and auto ingest. Different execution contexts may have different ingest job settings.

Parameters

executionContext The execution context identifier.

Definition at line 122 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.ALL_MODULES, and org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext.

org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings	(	String	executionContext,
		IngestType	ingestType
	)

Loads the ingest job settings for a given execution context. If settings for the context have not been previously saved, default settings are used.

Some examples of execution contexts include the Add Data Source wizard, the Run Ingest Modules dialog, and auto ingest. Different execution contexts may have different ingest job settings.

Parameters

executionContext	The execution context identifier.
ingestType	Whether to run all ingest modules, data source level ingest modules only, or file level ingest modules only.

Definition at line 140 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.ALL_MODULES, org.sleuthkit.autopsy.ingest.IngestJobSettings.createSavedModuleSettingsFolder(), org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, org.sleuthkit.autopsy.ingest.IngestJobSettings.ingestType, and org.sleuthkit.autopsy.ingest.IngestJobSettings.load().

org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings	(	String	executionContext,
		IngestType	ingestType,
		Collection< IngestModuleTemplate >	moduleTemplates
	)

Creates entirely new ingest job settings for a given context without saving them.

Parameters

executionContext	The execution context identifier.
ingestType	Whether to run all ingest modules, data source level ingest modules only, or file level ingest modules only.
moduleTemplates	A collection of ingest module templates for creating fully configured ingest modules; each template combines an ingest module factory with ingest module job settings and an enabled flag.

Definition at line 164 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.ALL_MODULES, org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, and org.sleuthkit.autopsy.ingest.IngestJobSettings.ingestType.

org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings	(	String	executionContext,
		IngestType	ingestType,
		Collection< IngestModuleTemplate >	moduleTemplates,
		FilesSet	fileFilter
	)

Creates entirely new ingest job settings for a given context without saving them.

Parameters

executionContext	The execution context identifier.
ingestType	Whether to run all ingest modules, data source level ingest modules only, or file level ingest modules only.
moduleTemplates	A collection of ingest module templates for creating fully configured ingest modules; each template combines an ingest module factory with ingest module job settings and an enabled flag.
fileFilter	A file filter in the form of a files set.

Definition at line 188 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, org.sleuthkit.autopsy.ingest.IngestJobSettings.ingestType, org.sleuthkit.autopsy.ingest.IngestJobSettings.moduleTemplates, and org.sleuthkit.autopsy.ingest.IngestJobSettings.setFileFilter().

Member Function Documentation

void org.sleuthkit.autopsy.ingest.IngestJobSettings.createSavedModuleSettingsFolder ( )

private

Creates the module folder for these ingest job settings, if it does not already exist.

Definition at line 324 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.getSavedModuleSettingsFolder().

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings(), org.sleuthkit.autopsy.ingest.IngestJobSettings.save(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.saveAs().

List<IngestModuleTemplate> org.sleuthkit.autopsy.ingest.IngestJobSettings.getEnabledIngestModuleTemplates ( )

Gets the enabled ingest module templates for this ingest job.

Returns: The list of enabled ingest module templates.

Definition at line 296 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IngestModuleSetupManager.configure().

String org.sleuthkit.autopsy.ingest.IngestJobSettings.getExecutionContext ( )

Gets the execution context identifier.

Some examples of execution contexts include the Add Data Source wizard, the Run Ingest Modules dialog, and auto ingest. Different execution contexts may have different ingest job settings.

Returns: The execution context identifier.

Definition at line 247 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext.

Referenced by org.sleuthkit.autopsy.integrationtesting.IngestModuleSetupManager.configure().

FilesSet org.sleuthkit.autopsy.ingest.IngestJobSettings.getFileFilter ( )

Gets the file filter for the ingest job.

Returns: FilesSet The filter as a files set.

Definition at line 256 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.fileFilter, and org.sleuthkit.autopsy.modules.interestingitems.FilesSetsManager.getDefaultFilter().

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.fileIngestFilterComboBoxActionPerformed(), and org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.IngestJobSettingsPanel().

List<IngestModuleTemplate> org.sleuthkit.autopsy.ingest.IngestJobSettings.getIngestModuleTemplates ( )

Gets the enabled ingest module templates for the ingest job.

Returns: The list of ingest module templates.

Definition at line 277 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.IngestJobSettingsPanel().

String org.sleuthkit.autopsy.ingest.IngestJobSettings.getModuleSettingsFilePath ( IngestModuleFactory factory )

private

Returns the absolute path for the ingest job settings file for a given ingest module for these ingest job settings.

Parameters

factory The ingest module factory for an ingest module.

Returns: The file path.

Definition at line 582 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.MODULE_SETTINGS_FILE_EXT, and org.sleuthkit.autopsy.python.FactoryClassNameNormalizer.normalize().

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings().

static HashSet<String> org.sleuthkit.autopsy.ingest.IngestJobSettings.getModulesNames	(	String	executionContext,
		String	propertyName,
		String	defaultSetting
	)

staticprivate

Gets a list of enabled module names from the properties file for the execution context of these ingest job settings.

Parameters

executionContext	The execution context identifier.
propertyName	The property name.
defaultSetting	The default list of module names to se and return if the property does not exist.

Returns

Definition at line 475 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.settingExists().

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load().

boolean org.sleuthkit.autopsy.ingest.IngestJobSettings.getProcessUnallocatedSpace ( )

Gets the process unallocated space flag for this ingest job.

Returns: True or false.

Definition at line 312 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.modules.interestingitems.FilesSet.ingoresUnallocatedSpace().

Path org.sleuthkit.autopsy.ingest.IngestJobSettings.getSavedModuleSettingsFolder ( )

Gets the path to the module settings folder for these ingest job settings.

Returns: The path to the ingest module settings folder.

Definition at line 199 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.createSavedModuleSettingsFolder().

List<String> org.sleuthkit.autopsy.ingest.IngestJobSettings.getWarnings ( )

Gets and clears any accumulated warnings associated with the loading or saving of these ingest job settings.

Returns: A list of warning messages, possibly empty.

Definition at line 232 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.warnings.

Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineIngestManager.JobProcessingTask.analyze(), and org.sleuthkit.autopsy.commandlineingest.CommandLineIngestSettingsPanel.showWarnings().

boolean org.sleuthkit.autopsy.ingest.IngestJobSettings.isPythonModuleSettingsFile ( String moduleSettingsFilePath )

private

Determines if the moduleSettingsFilePath is that of a serialized jython instance. Serialized Jython instances (settings saved on the disk) contain "org.python.proxies." in their fileName based on the current implementation.

Parameters

moduleSettingsFilePath path to the module settings file.

Returns: True or false

Definition at line 544 of file IngestJobSettings.java.

void org.sleuthkit.autopsy.ingest.IngestJobSettings.load ( )

private

Loads the saved or default ingest job settings for the execution context into memory.

Get the ingest module factories discovered by the ingest module loader.

Hard coding Plaso to be disabled by default. loadedModuleNames is passed below as the default list of enabled modules so briefly remove Plaso from loaded modules to get the list of enabled and disabled modules names. Then put Plaso back into loadedModulesNames to let the rest of the code continue as before.

Get the enabled/disabled ingest modules settings for this context. By default, all loaded modules except Plaso are enabled.

Check for missing modules and create warnings if any are found.

Create ingest module templates. Each template encapsulates a module factory, the module settings for this context, and an enabled flag.

Update the enabled/disabled ingest module settings for this context to reflect any missing modules or newly discovered modules.

Restore the last used File Ingest Filter

Definition at line 339 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings().

IngestModuleIngestJobSettings org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings ( IngestModuleFactory factory )

private

Gets the saved or default ingest job settings for a given ingest module.

Parameters

factory The ingest module factory.

Returns: The ingest module settings.

Definition at line 555 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, org.sleuthkit.autopsy.ingest.IngestModuleFactory.getDefaultIngestJobSettings(), org.sleuthkit.autopsy.ingest.IngestModuleFactory.getModuleDisplayName(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.getModuleSettingsFilePath().

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load().

static String org.sleuthkit.autopsy.ingest.IngestJobSettings.makeCsvList ( Collection< String > collection )

staticprivate

Makes a comma-separated values list from a collection of strings.

Parameters

collection A collection of strings.

Returns: The contents of the collection as a single string of comma-separated values.

Definition at line 642 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().

void org.sleuthkit.autopsy.ingest.IngestJobSettings.save ( )

Saves these ingest job settings.

Definition at line 206 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.createSavedModuleSettingsFolder(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().

Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineIngestSettingsPanel.displayIngestJobSettingsPanel().

void org.sleuthkit.autopsy.ingest.IngestJobSettings.saveAs ( String executionContext )

Saves these ingest job settings for use in a different execution context.

Some examples of execution contexts include the Add Data Source wizard, the Run Ingest Modules dialog, and auto ingest. Different execution contexts may have different ingest job settings.

Parameters

executionContext The new execution context.

Definition at line 220 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.createSavedModuleSettingsFolder(), org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().

void org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings	(	IngestModuleFactory	factory,
		IngestModuleIngestJobSettings	settings
	)

private

Serializes the ingest job settings for a given ingest module.

Parameters

factory	The ingest module factory for the module.
settings	The ingest job settings for the ingest module

Definition at line 623 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, org.sleuthkit.autopsy.ingest.IngestModuleFactory.getModuleDisplayName(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.getModuleSettingsFilePath().

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.store().

void org.sleuthkit.autopsy.ingest.IngestJobSettings.setFileFilter ( FilesSet fileIngestFilter )

Sets the file filter for the ingest job.

Parameters

fileIngestFilter The filter as a files set.

Definition at line 268 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineIngestManager.JobProcessingTask.analyze(), org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings(), and org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.updateSelectedFilter().

void org.sleuthkit.autopsy.ingest.IngestJobSettings.setIngestModuleTemplates ( List< IngestModuleTemplate > moduleTemplates )

Sets the enabled ingest module templates for the ingest job.

Parameters

moduleTemplates The ingest module templates.

Definition at line 286 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.getSettings().

void org.sleuthkit.autopsy.ingest.IngestJobSettings.store ( )

private

Saves the ingest job settings for this context.

Save the enabled/disabled ingest module settings.

Save the last used File Ingest Filter setting for this context.

Definition at line 591 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.DISABLED_MODULES_PROPERTY, org.sleuthkit.autopsy.ingest.IngestJobSettings.ENABLED_MODULES_PROPERTY, org.sleuthkit.autopsy.modules.interestingitems.FilesSet.getName(), org.sleuthkit.autopsy.ingest.IngestJobSettings.makeCsvList(), org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.save(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.saveAs().

Member Data Documentation

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.DISABLED_MODULES_PROPERTY = "Disabled_Ingest_Modules"

staticprivate

Definition at line 52 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.ENABLED_MODULES_PROPERTY = "Enabled_Ingest_Modules"

staticprivate

Definition at line 51 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().

String org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext

private

Definition at line 72 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.getExecutionContext(), org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings(), org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings(), org.sleuthkit.autopsy.ingest.IngestJobSettings.saveAs(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings().

FilesSet org.sleuthkit.autopsy.ingest.IngestJobSettings.fileFilter

private

Definition at line 73 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.getFileFilter().

final IngestType org.sleuthkit.autopsy.ingest.IngestJobSettings.ingestType

private

Definition at line 69 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings().

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.LAST_FILE_INGEST_FILTER_PROPERTY = "Last_File_Ingest_Filter"

staticprivate

Definition at line 53 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load().

final Logger org.sleuthkit.autopsy.ingest.IngestJobSettings.logger = Logger.getLogger(IngestJobSettings.class.getName())

staticprivate

Definition at line 68 of file IngestJobSettings.java.

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.MODULE_SETTINGS_FILE_EXT = ".settings"

staticprivate

Definition at line 66 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.getModuleSettingsFilePath().

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.MODULE_SETTINGS_FOLDER

staticprivate

Initial value:

= Paths.get(
            Paths.get(PlatformUtil.getUserConfigDirectory()).relativize(Paths.get(PlatformUtil.getModuleConfigDirectory())).toString(),
            MODULE_SETTINGS_FOLDER_NAME
    ).toString()

Definition at line 56 of file IngestJobSettings.java.

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.MODULE_SETTINGS_FOLDER_NAME = "IngestSettings"

staticprivate

Definition at line 54 of file IngestJobSettings.java.

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.MODULE_SETTINGS_FOLDER_PATH

staticprivate

Initial value:

= Paths.get(
            PlatformUtil.getModuleConfigDirectory(),
            IngestJobSettings.MODULE_SETTINGS_FOLDER_NAME
    ).toAbsolutePath().toString()

Definition at line 61 of file IngestJobSettings.java.

String org.sleuthkit.autopsy.ingest.IngestJobSettings.moduleSettingsFolderPath

private

Definition at line 74 of file IngestJobSettings.java.

final List<IngestModuleTemplate> org.sleuthkit.autopsy.ingest.IngestJobSettings.moduleTemplates = new ArrayList<>()

private

Definition at line 70 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings().

final CharSequence org.sleuthkit.autopsy.ingest.IngestJobSettings.PYTHON_CLASS_PROXY_PREFIX = "org.python.proxies.".subSequence(0, "org.python.proxies.".length() - 1)

staticprivate

Definition at line 67 of file IngestJobSettings.java.

final List<String> org.sleuthkit.autopsy.ingest.IngestJobSettings.warnings = new ArrayList<>()

private

Definition at line 71 of file IngestJobSettings.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.getWarnings().

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

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

Classes

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation