Inherited by org.sleuthkit.autopsy.examples.SampleIngestModuleFactory, org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter, org.sleuthkit.autopsy.modules.encryptiondetection.EncryptionDetectionModuleFactory, and org.sleuthkit.autopsy.modules.plaso.PlasoModuleFactory.

Public Member Functions
default DataSourceIngestModule	createDataSourceIngestModule (IngestModuleIngestJobSettings ingestOptions)

default FileIngestModule	createFileIngestModule (IngestModuleIngestJobSettings settings)

default IngestModuleIngestJobSettings	getDefaultIngestJobSettings ()

default IngestModuleGlobalSettingsPanel	getGlobalSettingsPanel ()

default IngestModuleIngestJobSettingsPanel	getIngestJobSettingsPanel (IngestModuleIngestJobSettings settings)

String	getModuleDescription ()

String	getModuleDisplayName ()

String	getModuleVersionNumber ()

default boolean	hasGlobalSettingsPanel ()

default boolean	hasIngestJobSettingsPanel ()

default boolean	isDataSourceIngestModuleFactory ()

default boolean	isFileIngestModuleFactory ()

Detailed Description

An interface that must be implemented by all providers of Autopsy ingest modules. An ingest module factory is used to create instances of a type of data source ingest module, a type of file ingest module, or both.

Autopsy will generally use the factory to create 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.

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

An ingest module factory may provide global and per ingest job settings user interface panels. The global settings should apply to all module instances. The per ingest job settings should apply to all module instances working on a particular ingest job. Autopsy supports context-sensitive and persistent per ingest job settings, so per ingest job settings must be serializable.

To be discovered at runtime by the ingest framework, IngestModuleFactory implementations must be marked with the following NetBeans Service provider annotation:

@ServiceProvider(service=IngestModuleFactory.class)

IMPORTANT TIP: If an implementation of IngestModuleFactory does not need to provide implementations of all of the IngestModuleFactory methods, it can extend the abstract class IngestModuleFactoryAdapter to get default implementations of most of the IngestModuleFactory methods.

Definition at line 59 of file IngestModuleFactory.java.

Member Function Documentation

default DataSourceIngestModule org.sleuthkit.autopsy.ingest.IngestModuleFactory.createDataSourceIngestModule ( IngestModuleIngestJobSettings ingestOptions )

Creates a data source 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.

Parameters

ingestOptions The settings for the ingest job.

Returns: A data source ingest module instance.

Definition at line 192 of file IngestModuleFactory.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestModuleTemplate.createDataSourceIngestModule().

default FileIngestModule org.sleuthkit.autopsy.ingest.IngestModuleFactory.createFileIngestModule ( IngestModuleIngestJobSettings settings )

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.

Parameters

settings The settings for the ingest job.

Returns: A file ingest module instance.

Definition at line 231 of file IngestModuleFactory.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestModuleTemplate.createFileIngestModule().

default IngestModuleIngestJobSettings org.sleuthkit.autopsy.ingest.IngestModuleFactory.getDefaultIngestJobSettings ( )

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.

Returns: The default ingest job settings.

Definition at line 125 of file IngestModuleFactory.java.

Referenced by org.sleuthkit.autopsy.testutils.IngestUtils.getIngestModuleTemplate(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings().

default IngestModuleGlobalSettingsPanel org.sleuthkit.autopsy.ingest.IngestModuleFactory.getGlobalSettingsPanel ( )

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.

Returns: A global settings panel.

Definition at line 112 of file IngestModuleFactory.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestModuleTemplate.getGlobalSettingsPanel().

default IngestModuleIngestJobSettingsPanel org.sleuthkit.autopsy.ingest.IngestModuleFactory.getIngestJobSettingsPanel ( IngestModuleIngestJobSettings settings )

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.

Parameters

settings Per ingest job settings to initialize the panel.

Returns: An ingest job settings panel.

Definition at line 153 of file IngestModuleFactory.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestModuleTemplate.getModuleSettingsPanel().

String org.sleuthkit.autopsy.ingest.IngestModuleFactory.getModuleDescription ( )

Gets a brief, user-friendly description of the family of ingest modules the factory creates. Autopsy uses this string to describe the module in user interface components.

Returns: The module family description.

Referenced by org.sleuthkit.autopsy.ingest.IngestModuleTemplate.getModuleDescription().

String org.sleuthkit.autopsy.ingest.IngestModuleFactory.getModuleDisplayName ( )

Gets the display name that identifies the family of ingest modules the factory creates. Autopsy uses this string to identify the module in user interface components and log messages. The module name must be unique. so a brief but distinctive name is recommended.

Returns: The module family display name.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.IngestModulesTableModel.getIcon(), org.sleuthkit.autopsy.ingest.IngestModuleTemplate.getModuleName(), org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings().

String org.sleuthkit.autopsy.ingest.IngestModuleFactory.getModuleVersionNumber ( )

Gets the version number of the family of ingest modules the factory creates.

Returns: The module family version number.

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

default boolean org.sleuthkit.autopsy.ingest.IngestModuleFactory.hasGlobalSettingsPanel ( )

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.

Returns: True if the factory provides a global settings panel.

Definition at line 98 of file IngestModuleFactory.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestModuleTemplate.hasGlobalSettingsPanel().

default boolean org.sleuthkit.autopsy.ingest.IngestModuleFactory.hasIngestJobSettingsPanel ( )

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.

Returns: True if the factory provides ingest job settings panels.

Definition at line 138 of file IngestModuleFactory.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestModuleTemplate.hasModuleSettingsPanel().

default boolean org.sleuthkit.autopsy.ingest.IngestModuleFactory.isDataSourceIngestModuleFactory ( )

Queries the factory to determine if it is capable of creating data source ingest modules.

Returns: True if the factory can create data source ingest modules.

Definition at line 163 of file IngestModuleFactory.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.IngestModulesTableModel.getIcon(), and org.sleuthkit.autopsy.ingest.IngestModuleTemplate.isDataSourceIngestModuleTemplate().

default boolean org.sleuthkit.autopsy.ingest.IngestModuleFactory.isFileIngestModuleFactory ( )

Queries the factory to determine if it is capable of creating file ingest modules.

Returns: True if the factory can create file ingest modules.

Definition at line 202 of file IngestModuleFactory.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.IngestModulesTableModel.getIcon(), and org.sleuthkit.autopsy.ingest.IngestModuleTemplate.isFileIngestModuleTemplate().

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

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

Public Member Functions

Detailed Description

Member Function Documentation