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

Classes

enum  IngestType
 

Public Member Functions

 IngestJobSettings (String executionContext)
 
 IngestJobSettings (String context, IngestType ingestType)
 
Path getSavedModuleSettingsFolder ()
 
List< String > getWarnings ()
 
void save ()
 

Private Member Functions

void createSavedModuleSettingsFolder ()
 
String getModuleSettingsFilePath (IngestModuleFactory factory)
 
HashSet< String > getModulesNamesFromSetting (String key, String defaultSetting)
 
boolean isPythonModuleSettingsFile (String moduleSettingsFilePath)
 
void load ()
 
IngestModuleIngestJobSettings loadModuleSettings (IngestModuleFactory factory)
 
void saveModuleSettings (IngestModuleFactory factory, IngestModuleIngestJobSettings settings)
 
void store ()
 

Static Private Member Functions

static String makeCommaSeparatedValuesList (HashSet< String > input)
 

Private Attributes

final String executionContext
 
final IngestType ingestType
 
String moduleSettingsFolderPath
 
final List< IngestModuleTemplate > moduleTemplates
 
boolean processUnallocatedSpace
 
final List< String > warnings
 

Static Private Attributes

static final String DISABLED_MODULES_KEY = "Disabled_Ingest_Modules"
 
static final String ENABLED_MODULES_KEY = "Enabled_Ingest_Modules"
 
static final Logger logger = Logger.getLogger(IngestJobSettings.class.getName())
 
static final String MODULE_SETTINGS_FILE_EXT = ".settings"
 
static final String MODULE_SETTINGS_FOLDER = "IngestModuleSettings"
 
static final String MODULE_SETTINGS_FOLDER_PATH = Paths.get(PlatformUtil.getUserConfigDirectory(), IngestJobSettings.MODULE_SETTINGS_FOLDER).toAbsolutePath().toString()
 
static final String PARSE_UNALLOC_SPACE_KEY = "Process_Unallocated_Space"
 
static final String PROCESS_UNALLOC_SPACE_DEFAULT = "true"
 
static final CharSequence pythonModuleSettingsPrefixCS = "org.python.proxies.".subSequence(0, "org.python.proxies.".length() - 1)
 

Detailed Description

Encapsulates the ingest job settings for a particular execution context. Examples of execution contexts include the add data source wizard and the run ingest modules dialog. Different execution conterxts may have different ingest job settings.

Definition at line 47 of file IngestJobSettings.java.

Constructor & Destructor Documentation

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

Constructs an ingest job settings object for a given execution context. Examples of execution contexts include the add data source wizard and the run ingest modules dialog. Different execution conterxts may have different ingest job settings.

Parameters
executionContextThe ingest execution context identifier.

Definition at line 92 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.load(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.PROCESS_UNALLOC_SPACE_DEFAULT.

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

Constructs an ingest job settings object for a given context. Examples of execution contexts include the add data source wizard and the run ingest modules dialog. Different execution conterxts may have different ingest job settings.

Parameters
contextThe context identifier string.
ingestTypeThe type of modules ingest is running.

Definition at line 111 of file IngestJobSettings.java.

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

Member Function Documentation

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

Creates the folder for saving the individual ingest module settings part of these ingest job settings.

Definition at line 225 of file IngestJobSettings.java.

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

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

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
factoryThe ingest module factory for an ingest module.
Returns
The file path.

Definition at line 428 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.MODULE_SETTINGS_FILE_EXT.

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

HashSet<String> org.sleuthkit.autopsy.ingest.IngestJobSettings.getModulesNamesFromSetting ( String  key,
String  defaultSetting 
)
private

Gets the module names for a given key within these ingest job settings.

Parameters
keyThe key string.
defaultSettingThe default list of module names.
Returns
The list of module names associated with the key.

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

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

Returns the path to the ingest module settings folder.

Returns
path to the module settings folder

Definition at line 217 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.MODULE_SETTINGS_FOLDER_PATH.

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

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

Gets and clears any accumulated warnings associated with these ingest job settings.

Returns
A list of warning messages, possibly empty.

Definition at line 152 of file IngestJobSettings.java.

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

Referenced by org.sleuthkit.autopsy.ingest.IngestJobConfigurator.getIngestJobConfigWarnings(), and org.sleuthkit.autopsy.ingest.RunIngestModulesDialog.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
moduleSettingsFilePathpath to the module settings file.
Returns
True or false

Definition at line 379 of file IngestJobSettings.java.

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

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

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

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

Get the enabled/disabled ingest modules settings for this context. By default, all loaded modules 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.

Definition at line 239 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.ALL_MODULES, org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.DATA_SOURCE_ONLY, org.sleuthkit.autopsy.ingest.IngestJobSettings.DISABLED_MODULES_KEY, org.sleuthkit.autopsy.ingest.IngestJobSettings.ENABLED_MODULES_KEY, org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.FILES_ONLY, org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), org.sleuthkit.autopsy.ingest.IngestJobSettings.getModulesNamesFromSetting(), org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings(), org.sleuthkit.autopsy.ingest.IngestJobSettings.makeCommaSeparatedValuesList(), org.sleuthkit.autopsy.ingest.IngestJobSettings.PARSE_UNALLOC_SPACE_KEY, org.sleuthkit.autopsy.ingest.IngestJobSettings.PROCESS_UNALLOC_SPACE_DEFAULT, org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.settingExists().

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

IngestModuleIngestJobSettings org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings ( IngestModuleFactory  factory)
private
static String org.sleuthkit.autopsy.ingest.IngestJobSettings.makeCommaSeparatedValuesList ( HashSet< String >  input)
staticprivate

Makes a comma-separated values list from a hash set of strings.

Parameters
inputA hash set of strings.
Returns
The contents of the hash set as a single string of comma-separated values.

Definition at line 496 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 ( )
void org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings ( IngestModuleFactory  factory,
IngestModuleIngestJobSettings  settings 
)
private

Serializes the ingest job settings for this context for a given ingest module.

Parameters
factoryThe ingest module factory for the module.
settingsThe ingest job settings for the ingest module

Definition at line 469 of file IngestJobSettings.java.

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

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

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 process unallocated space setting.

Definition at line 437 of file IngestJobSettings.java.

References org.sleuthkit.autopsy.ingest.IngestJobSettings.makeCommaSeparatedValuesList(), org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

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

Member Data Documentation

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.DISABLED_MODULES_KEY = "Disabled_Ingest_Modules"
staticprivate
final String org.sleuthkit.autopsy.ingest.IngestJobSettings.ENABLED_MODULES_KEY = "Enabled_Ingest_Modules"
staticprivate
final String org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext
private
final IngestType org.sleuthkit.autopsy.ingest.IngestJobSettings.ingestType
private
final Logger org.sleuthkit.autopsy.ingest.IngestJobSettings.logger = Logger.getLogger(IngestJobSettings.class.getName())
staticprivate

Definition at line 56 of file IngestJobSettings.java.

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

Definition at line 53 of file IngestJobSettings.java.

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.MODULE_SETTINGS_FOLDER_PATH = Paths.get(PlatformUtil.getUserConfigDirectory(), IngestJobSettings.MODULE_SETTINGS_FOLDER).toAbsolutePath().toString()
staticprivate
String org.sleuthkit.autopsy.ingest.IngestJobSettings.moduleSettingsFolderPath
private

Definition at line 59 of file IngestJobSettings.java.

final List<IngestModuleTemplate> org.sleuthkit.autopsy.ingest.IngestJobSettings.moduleTemplates
private

Definition at line 61 of file IngestJobSettings.java.

final String org.sleuthkit.autopsy.ingest.IngestJobSettings.PARSE_UNALLOC_SPACE_KEY = "Process_Unallocated_Space"
staticprivate
final String org.sleuthkit.autopsy.ingest.IngestJobSettings.PROCESS_UNALLOC_SPACE_DEFAULT = "true"
staticprivate
boolean org.sleuthkit.autopsy.ingest.IngestJobSettings.processUnallocatedSpace
private

Definition at line 62 of file IngestJobSettings.java.

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

Definition at line 60 of file IngestJobSettings.java.

final List<String> org.sleuthkit.autopsy.ingest.IngestJobSettings.warnings
private

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

Copyright © 2012-2015 Basis Technology. Generated on: Wed Apr 6 2016
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.