Inherits org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Public Member Functions
default DataArtifactIngestModule	createDataArtifactIngestModule (IngestModuleIngestJobSettings settings)

DataSourceIngestModule	createDataSourceIngestModule (IngestModuleIngestJobSettings ingestOptions)

FileIngestModule	createFileIngestModule (IngestModuleIngestJobSettings ingestOptions)

IngestModuleIngestJobSettings	getDefaultIngestJobSettings ()

IngestModuleGlobalSettingsPanel	getGlobalSettingsPanel ()

IngestModuleIngestJobSettingsPanel	getIngestJobSettingsPanel (IngestModuleIngestJobSettings settings)

abstract String	getModuleDescription ()

abstract String	getModuleDisplayName ()

abstract String	getModuleVersionNumber ()

boolean	hasGlobalSettingsPanel ()

boolean	hasIngestJobSettingsPanel ()

default boolean	isDataArtifactIngestModuleFactory ()

boolean	isDataSourceIngestModuleFactory ()

boolean	isFileIngestModuleFactory ()

Detailed Description

An adapter that provides no-op implementations of various IngestModuleFactory methods.

NOTE: As of Java 8, interfaces can have default methods. IngestModuleFactory now provides default no-op versions of all of its optional methods. This class is no longer needed and can be DEPRECATED when convenient.

Definition at line 29 of file IngestModuleFactoryAdapter.java.

Member Function Documentation

default DataArtifactIngestModule org.sleuthkit.autopsy.ingest.IngestModuleFactory.createDataArtifactIngestModule ( IngestModuleIngestJobSettings settings )

inherited

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

Implemented in org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoIngestModuleFactory.

Definition at line 270 of file IngestModuleFactory.java.

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

DataSourceIngestModule org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 71 of file IngestModuleFactoryAdapter.java.

FileIngestModule org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.createFileIngestModule ( IngestModuleIngestJobSettings ingestOptions )

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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 81 of file IngestModuleFactoryAdapter.java.

IngestModuleIngestJobSettings org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 51 of file IngestModuleFactoryAdapter.java.

IngestModuleGlobalSettingsPanel org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 46 of file IngestModuleFactoryAdapter.java.

IngestModuleIngestJobSettingsPanel org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 61 of file IngestModuleFactoryAdapter.java.

abstract String org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.getModuleDescription ( )

abstract

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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

abstract String org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.getModuleDisplayName ( )

abstract

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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

abstract String org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.getModuleVersionNumber ( )

abstract

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

Returns: The module family version number.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

boolean org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 41 of file IngestModuleFactoryAdapter.java.

boolean org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 56 of file IngestModuleFactoryAdapter.java.

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

inherited

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

Returns: True or false.

Implemented in org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoIngestModuleFactory.

Definition at line 241 of file IngestModuleFactory.java.

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

boolean org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 66 of file IngestModuleFactoryAdapter.java.

boolean org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.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.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 76 of file IngestModuleFactoryAdapter.java.

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

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

Public Member Functions

Detailed Description

Member Function Documentation