Autopsy  4.19.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Protected Attributes | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.recentactivity.RAImageIngestModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.DataSourceIngestModule.

Public Member Functions

ProcessResult process (Content dataSource, DataSourceIngestModuleProgress progressBar)
 
default void shutDown ()
 
void startUp (IngestJobContext context) throws IngestModuleException
 

Protected Attributes

SleuthkitCase tskCase
 

Static Private Member Functions

static String getAndMakeRAPath (String basePath, String module, long ingestJobId)
 

Private Attributes

RAOsAccountCache accountCache = new RAOsAccountCache()
 
final List< Extract > browserExtractors = new ArrayList<>()
 
IngestJobContext context
 
final List< Extract > extractors = new ArrayList<>()
 
final IngestServices services = IngestServices.getInstance()
 
final StringBuilder subCompleted = new StringBuilder()
 

Static Private Attributes

static final Logger logger = Logger.getLogger(RAImageIngestModule.class.getName())
 
static final String RECENT_ACTIVITY_FOLDER = "RecentActivity"
 

Detailed Description

Recent activity image ingest module

Definition at line 50 of file RAImageIngestModule.java.

Member Function Documentation

static String org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.getAndMakeRAPath ( String  basePath,
String  module,
long  ingestJobId 
)
staticprivate

Makes a path of the format [basePath]/[RECENT_ACTIVITY_FOLDER]/[module]_[ingest job id] if it does not already exist and returns the created folder.

Parameters
basePathThe base path (a case-related folder like temp or output).
moduleThe module name to include in the folder name.
ingestJobIdThe id of the ingest job.
Returns
The path to the folder.

Definition at line 231 of file RAImageIngestModule.java.

ProcessResult org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.process ( Content  dataSource,
DataSourceIngestModuleProgress  progressBar 
)

Processes a data source. Called once between calls to startUp() and shutDown().

IMPORTANT: In addition to returning ProcessResult.OK or ProcessResult.ERROR, modules should log all errors using methods provided by the org.sleuthkit.autopsy.coreutils.Logger class. Log messages should include the name and object ID of the data being processed. If an exception has been caught by the module, the exception should be sent to the Logger along with the log message so that a stack trace will appear in the application log.

Parameters
dataSourceThe data source to process.
progressBarA progress bar to be used to report progress.
Returns
A result code indicating success or failure of the processing.

Implements org.sleuthkit.autopsy.ingest.DataSourceIngestModule.

Definition at line 119 of file RAImageIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createMessage(), org.sleuthkit.autopsy.ingest.IngestJobContext.dataSourceIngestIsCancelled(), org.sleuthkit.autopsy.ingest.IngestMessage.MessageType.ERROR, org.sleuthkit.autopsy.ingest.IngestMessage.MessageType.INFO, org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK, org.sleuthkit.autopsy.ingest.IngestServices.postMessage(), org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProgress.progress(), and org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProgress.switchToDeterminate().

default void org.sleuthkit.autopsy.ingest.IngestModule.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.

Implemented in org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule, org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule, org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule, org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule, org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule, org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule, org.sleuthkit.autopsy.modules.yara.YaraIngestModule, and org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.

Definition at line 86 of file IngestModule.java.

void org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.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 66 of file RAImageIngestModule.java.

References org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.context, org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

Member Data Documentation

RAOsAccountCache org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.accountCache = new RAOsAccountCache()
private

Definition at line 60 of file RAImageIngestModule.java.

final List<Extract> org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.browserExtractors = new ArrayList<>()
private

Definition at line 55 of file RAImageIngestModule.java.

IngestJobContext org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.context
private
final List<Extract> org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.extractors = new ArrayList<>()
private

Definition at line 54 of file RAImageIngestModule.java.

final Logger org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.logger = Logger.getLogger(RAImageIngestModule.class.getName())
staticprivate

Definition at line 53 of file RAImageIngestModule.java.

final String org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.RECENT_ACTIVITY_FOLDER = "RecentActivity"
staticprivate

Definition at line 52 of file RAImageIngestModule.java.

final IngestServices org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.services = IngestServices.getInstance()
private

Definition at line 56 of file RAImageIngestModule.java.

final StringBuilder org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.subCompleted = new StringBuilder()
private

Definition at line 58 of file RAImageIngestModule.java.

SleuthkitCase org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.tskCase
protected

Definition at line 59 of file RAImageIngestModule.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.