Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.FileIngestModuleAdapter.

Public Member Functions

ProcessResult process (AbstractFile file)
 
void shutDown ()
 
void startUp (IngestJobContext context) throws IngestModuleException
 

Private Attributes

IngestJobContext context
 
FileTypeDetector fileTypeDetector
 
Collection<?extends PictureProcessorregistry
 

Detailed Description

Ingest module to do arbitrary work on image files. Some examples include extracting EXIF, converting between formats, and creating thumbnails. This module acts as a container for multiple PictureProcessors, which are the classes that do the work mentioned in the examples above.

Definition at line 40 of file PictureAnalyzerIngestModule.java.

Member Function Documentation

ProcessResult org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule.process ( AbstractFile  file)

Processes a file. Called between calls to startUp() and shutDown(). Will be called for each file in a data source.

Parameters
fileThe file to analyze.
Returns
A result code indicating success or failure of the processing.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

Definition at line 47 of file PictureAnalyzerIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled(), org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector.getMIMEType(), and org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK.

void org.sleuthkit.autopsy.ingest.FileIngestModuleAdapter.shutDown ( )
inherited

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.modules.pictureanalyzer.PictureAnalyzerIngestModule.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.

Parameters
contextProvides data and services specific to the ingest job and the ingest pipeline of which the module is a part.
Exceptions
org.sleuthkit.autopsy.ingest.IngestModule.IngestModuleException

Implements org.sleuthkit.autopsy.ingest.IngestModule.

Definition at line 76 of file PictureAnalyzerIngestModule.java.

References org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule.context.

Member Data Documentation

IngestJobContext org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule.context
private
FileTypeDetector org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule.fileTypeDetector
private

Definition at line 42 of file PictureAnalyzerIngestModule.java.

Collection<? extends PictureProcessor> org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule.registry
private

Definition at line 43 of file PictureAnalyzerIngestModule.java.


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

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.