Autopsy  4.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.modules.vmextractor.VMExtractorIngestModuleFactory Class Reference

Inherits org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.

Public Member Functions

DataSourceIngestModule createDataSourceIngestModule (IngestModuleIngestJobSettings settings)
 
FileIngestModule createFileIngestModule (IngestModuleIngestJobSettings ingestOptions)
 
IngestModuleIngestJobSettings getDefaultIngestJobSettings ()
 
IngestModuleGlobalSettingsPanel getGlobalSettingsPanel ()
 
IngestModuleIngestJobSettingsPanel getIngestJobSettingsPanel (IngestModuleIngestJobSettings ingestOptions)
 
String getModuleDescription ()
 
String getModuleDisplayName ()
 
String getModuleVersionNumber ()
 
boolean hasGlobalSettingsPanel ()
 
boolean hasIngestJobSettingsPanel ()
 
boolean isDataSourceIngestModuleFactory ()
 
boolean isFileIngestModuleFactory ()
 

Detailed Description

An factory for ingest modules that extracts virtual machine files and adds them to a case as data sources.

Definition at line 33 of file VMExtractorIngestModuleFactory.java.

Member Function Documentation

DataSourceIngestModule org.sleuthkit.autopsy.modules.vmextractor.VMExtractorIngestModuleFactory.createDataSourceIngestModule ( IngestModuleIngestJobSettings  settings)
FileIngestModule org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.createFileIngestModule ( IngestModuleIngestJobSettings  settings)
inherited

Creates a file ingest module instance.

Autopsy will generally use the factory to several instances of each type of module for each ingest job it performs. Completing an ingest job entails processing a single data source (e.g., a disk image) and all of the files from the data source, including files extracted from archives and any unallocated space (made to look like a series of files). The data source is passed through one or more pipelines of data source ingest modules. The files are passed through one or more pipelines of file ingest modules.

The ingest framework may use multiple threads to complete an ingest job, but it is guaranteed that there will be no more than one module instance per thread. However, if the module instances must share resources, the modules are responsible for synchronizing access to the shared resources and doing reference counting as required to release those resources correctly. Also, more than one ingest job may be in progress at any given time. This must also be taken into consideration when sharing resources between module instances. modules.

If the module family does not include file ingest modules, the factory may extend IngestModuleFactoryAdapter to get an implementation of this method that throws an UnsupportedOperationException.

Parameters
settingsThe settings for the ingest job.
Returns
A file ingest module instance.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 77 of file IngestModuleFactoryAdapter.java.

IngestModuleIngestJobSettings org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.getDefaultIngestJobSettings ( )
inherited

Gets the default per ingest job settings for instances of the family of ingest modules the factory creates. For example, the Autopsy core hash lookup ingest modules family uses hash databases imported or created using its global settings panel. All of the hash databases are enabled by default for an ingest job. If the module family does not have per ingest job settings, the factory may extend IngestModuleFactoryAdapter to get an implementation of this method that returns an instance of the NoIngestModuleJobSettings class.

Returns
The default ingest job settings.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 47 of file IngestModuleFactoryAdapter.java.

IngestModuleGlobalSettingsPanel org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.getGlobalSettingsPanel ( )
inherited

Gets a user interface panel that allows a user to change settings that are used by all instances of the family of ingest modules the factory creates. For example, the Autopsy core hash lookup ingest module factory provides a global settings panel to import and create hash databases. The imported hash databases are then enabled or disabled per ingest job using ingest an ingest job settings panel. If the module family does not have a global settings, the factory may extend IngestModuleFactoryAdapter to get an implementation of this method that throws an UnsupportedOperationException.

Returns
A global settings panel.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 42 of file IngestModuleFactoryAdapter.java.

IngestModuleIngestJobSettingsPanel org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.getIngestJobSettingsPanel ( IngestModuleIngestJobSettings  settings)
inherited

Gets a user interface panel that can be used to set per ingest job settings for instances of the family of ingest modules the factory creates. For example, the core hash lookup ingest module factory provides an ingest job settings panel to enable or disable hash databases per ingest job. If the module family does not have per ingest job settings, the factory may extend IngestModuleFactoryAdapter to get an implementation of this method that throws an UnsupportedOperationException.

Parameters
settingPer ingest job settings to initialize the panel.
Returns
An ingest job settings panel.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 57 of file IngestModuleFactoryAdapter.java.

String org.sleuthkit.autopsy.modules.vmextractor.VMExtractorIngestModuleFactory.getModuleDescription ( )
String org.sleuthkit.autopsy.modules.vmextractor.VMExtractorIngestModuleFactory.getModuleDisplayName ( )
String org.sleuthkit.autopsy.modules.vmextractor.VMExtractorIngestModuleFactory.getModuleVersionNumber ( )
boolean org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.hasGlobalSettingsPanel ( )
inherited

Queries the factory to determine if it provides a user interface panel to allow a user to change settings that are used by all instances of the family of ingest modules the factory creates. For example, the Autopsy core hash lookup ingest module factory provides a global settings panel to import and create hash databases. The hash databases are then enabled or disabled per ingest job using an ingest job settings panel. If the module family does not have global settings, the factory may extend IngestModuleFactoryAdapter to get an implementation of this method that returns false.

Returns
True if the factory provides a global settings panel.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 37 of file IngestModuleFactoryAdapter.java.

boolean org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.hasIngestJobSettingsPanel ( )
inherited

Queries the factory to determine if it provides user a interface panel to allow a user to make per ingest job settings for instances of the family of ingest modules the factory creates. For example, the Autopsy core hash lookup ingest module factory provides an ingest job settings panels to enable or disable hash databases per ingest job. If the module family does not have per ingest job settings, the factory may extend IngestModuleFactoryAdapter to get an implementation of this method that returns false.

Returns
True if the factory provides ingest job settings panels.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 52 of file IngestModuleFactoryAdapter.java.

boolean org.sleuthkit.autopsy.modules.vmextractor.VMExtractorIngestModuleFactory.isDataSourceIngestModuleFactory ( )
boolean org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.isFileIngestModuleFactory ( )
inherited

Queries the factory to determine if it is capable of creating file ingest modules. If the module family does not include file ingest modules, the factory may extend IngestModuleFactoryAdapter to get an implementation of this method that returns false.

Returns
True if the factory can create file ingest modules.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 72 of file IngestModuleFactoryAdapter.java.


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.