org.sleuthkit.autopsy.recentactivity.RAImageIngestModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.DataSourceIngestModule.

Public Member Functions
ProcessResult	process (Content dataSource, DataSourceIngestModuleProgress progressBar)
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
final List< Extract >	browserExtractors = new ArrayList<>()
IngestJobContext	context
final List< Extract >	extractors = new ArrayList<>()
final IngestServices	services = IngestServices.getInstance()

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 48 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

basePath	The base path (a case-related folder like temp or output).
module	The module name to include in the folder name.
ingestJobId	The id of the ingest job.

Returns

The path to the folder.

Definition at line 219 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

dataSource	The data source to process.
progressBar	A 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 115 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().

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

IMPORTANT: Start up IngestModuleException messages are displayed to the user, if a user is present. Therefore, an exception to the policy that exception messages are not localized is appropriate in this method. Also, the exception messages should be user-friendly.

Parameters

context

Provides 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 62 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

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

private

Definition at line 53 of file RAImageIngestModule.java.

IngestJobContext org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.context

private

Definition at line 55 of file RAImageIngestModule.java.

Referenced by org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.startUp().

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

private

Definition at line 52 of file RAImageIngestModule.java.

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

staticprivate

Definition at line 51 of file RAImageIngestModule.java.

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

staticprivate

Definition at line 50 of file RAImageIngestModule.java.

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

private

Definition at line 54 of file RAImageIngestModule.java.

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

protected

Definition at line 56 of file RAImageIngestModule.java.

---

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

• /home/carriersleuth/repos/autopsy/RecentActivity/src/org/sleuthkit/autopsy/recentactivity/RAImageIngestModule.java