Autopsy  4.19.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.test.CustomArtifactsCreatorIngestModuleFactory Class Reference

Inherits org.sleuthkit.autopsy.ingest.IngestModuleFactoryAdapter.

Public Member Functions

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

Detailed Description

A factory for data source and file ingest modules that associate custom artifacts and attributes with content for test purposes. Uncomment the service provider annotation and required imports to activate this test fixture.

Definition at line 36 of file CustomArtifactsCreatorIngestModuleFactory.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
settingsThe 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.test.CustomArtifactsCreatorIngestModuleFactory.createDataSourceIngestModule ( IngestModuleIngestJobSettings  settings)

Creates a data source ingest module instance.

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

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 99 of file CustomArtifactsCreatorIngestModuleFactory.java.

FileIngestModule org.sleuthkit.autopsy.test.CustomArtifactsCreatorIngestModuleFactory.createFileIngestModule ( IngestModuleIngestJobSettings  settings)

Creates a file ingest module instance.

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

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 122 of file CustomArtifactsCreatorIngestModuleFactory.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.

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 ( )
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.

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

Parameters
settingsPer 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.

String org.sleuthkit.autopsy.test.CustomArtifactsCreatorIngestModuleFactory.getModuleDescription ( )

Gets a brief, user-friendly description of the family of ingest modules the factory creates.

Returns
The module family description.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 65 of file CustomArtifactsCreatorIngestModuleFactory.java.

String org.sleuthkit.autopsy.test.CustomArtifactsCreatorIngestModuleFactory.getModuleDisplayName ( )

Gets the display name that identifies the family of ingest modules the factory creates.

Returns
The module family display name.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 54 of file CustomArtifactsCreatorIngestModuleFactory.java.

String org.sleuthkit.autopsy.test.CustomArtifactsCreatorIngestModuleFactory.getModuleVersionNumber ( )

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.

Definition at line 76 of file CustomArtifactsCreatorIngestModuleFactory.java.

References org.sleuthkit.autopsy.coreutils.Version.getVersion().

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.

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 ( )
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.

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.test.CustomArtifactsCreatorIngestModuleFactory.isDataSourceIngestModuleFactory ( )

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

Returns
True.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 87 of file CustomArtifactsCreatorIngestModuleFactory.java.

boolean org.sleuthkit.autopsy.test.CustomArtifactsCreatorIngestModuleFactory.isFileIngestModuleFactory ( )

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

Returns
True.

Implements org.sleuthkit.autopsy.ingest.IngestModuleFactory.

Definition at line 110 of file CustomArtifactsCreatorIngestModuleFactory.java.


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

Copyright © 2012-2021 Basis Technology. Generated on: Fri Aug 6 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.