org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.DataSourceIngestModuleAdapter.

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

Private Attributes
IngestJobContext	context

Static Private Attributes
static final Logger	logger = Logger.getLogger(CustomArtifactsCreatorDataSourceIngestModule.class.getName())

Detailed Description

A data source ingest module that associates custom artifacts and attributes with data sources for test purposes.

Definition at line 39 of file CustomArtifactsCreatorDataSourceIngestModule.java.

Member Function Documentation

ProcessResult org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule.process	(	Content	dataSource,
		DataSourceIngestModuleProgress	progressBar
	)

Creates a custom artifact instance associated with the data source to be processed.

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 74 of file CustomArtifactsCreatorDataSourceIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.ERROR, org.sleuthkit.autopsy.ingest.IngestJobContext.getJobId(), and org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK.

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.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule, org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule, org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule, org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule, org.sleuthkit.autopsy.recentactivity.RAImageIngestModule, and org.sleuthkit.autopsy.modules.yara.YaraIngestModule.

Definition at line 91 of file IngestModule.java.

void org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule.startUp

(

IngestJobContext

context

)

throws IngestModuleException

Adds the custom artifact type this module uses to the case database of the current case.

Parameters

context

Provides data and services specific to the ingest job and the ingest pipeline of which the module is a part.

Exceptions

IngestModuleException

If there is an error adding the custom artifact type.

Implements org.sleuthkit.autopsy.ingest.IngestModule.

Definition at line 55 of file CustomArtifactsCreatorDataSourceIngestModule.java.

Member Data Documentation

IngestJobContext org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule.context

private

Definition at line 42 of file CustomArtifactsCreatorDataSourceIngestModule.java.

final Logger org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule.logger = Logger.getLogger(CustomArtifactsCreatorDataSourceIngestModule.class.getName())

staticprivate

Definition at line 41 of file CustomArtifactsCreatorDataSourceIngestModule.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/test/CustomArtifactsCreatorDataSourceIngestModule.java