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

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

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. 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
settingsPer 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.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. 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.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-2016 Basis Technology. Generated on: Tue Jun 13 2017
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.