|
Autopsy
4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
|
Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.
Inherited by org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule, org.sleuthkit.autopsy.modules.encryptiondetection.EncryptionDetectionFileIngestModule, org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule, org.sleuthkit.autopsy.modules.yara.YaraIngestModule, org.sleuthkit.autopsy.test.CustomArtifactsCreatorFileIngestModule, and org.sleuthkit.autopsy.test.InterestingArtifactCreatorIngestModule.
Public Member Functions | |
| abstract ProcessResult | process (AbstractFile file) |
| void | shutDown () |
| void | startUp (IngestJobContext context) throws IngestModuleException |
An adapter that provides no-op implementations of the startUp() and shutDown() methods for file ingest modules.
NOTE: As of Java 8, interfaces can have default methods. FileIngestModule now provides default no-op versions of startUp() and shutDown(). This class is no longer needed and can be deprecated when convenient.
Definition at line 31 of file FileIngestModuleAdapter.java.
|
abstract |
Processes a file. Called between calls to startUp() and shutDown(). Will be called for each file in a data source.
| file | The file to analyze. |
Implements org.sleuthkit.autopsy.ingest.FileIngestModule.
| void org.sleuthkit.autopsy.ingest.FileIngestModuleAdapter.shutDown | ( | ) |
Invoked by Autopsy when an ingest job is completed (either because the data has been analyzed or because the job was cancelled), before the ingest module instance is discarded. The module should respond by doing things like releasing private resources, submitting final results, and posting a final ingest message.
IMPORTANT: 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. See IngestModuleReferenceCounter.
Implements org.sleuthkit.autopsy.ingest.IngestModule.
Definition at line 41 of file FileIngestModuleAdapter.java.
| void org.sleuthkit.autopsy.ingest.FileIngestModuleAdapter.startUp | ( | IngestJobContext | context | ) | throws IngestModuleException |
Invoked by Autopsy to allow an ingest module instance to set up any internal data structures and acquire any private resources it will need during an ingest job. If the module depends on loading any resources, it should do so in this method so that it can throw an exception in the case of an error and alert the user. Exceptions that are thrown from startUp() are logged and stop processing of the data source.
IMPORTANT: 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. See IngestModuleReferenceCounter.
| context | Provides data and services specific to the ingest job and the ingest pipeline of which the module is a part. |
Implements org.sleuthkit.autopsy.ingest.IngestModule.
Definition at line 34 of file FileIngestModuleAdapter.java.
Copyright © 2012-2021 Basis Technology. Generated on: Thu Jul 8 2021
This work is licensed under a
Creative Commons Attribution-Share Alike 3.0 United States License.