Inherits org.sleuthkit.autopsy.ingest.DataArtifactIngestModule.

Public Member Functions
ProcessResult	process (DataArtifact artifact)

void	shutDown ()

default void	startUp (IngestJobContext context) throws IngestModuleException

Private Attributes
final AtomicLong	artifactCounter = new AtomicLong()

Detailed Description

RJCTODO

NOTE TO REVIEWER:

This is a placeholder data artifact ingest module that counts the number of data artifacts it processes and posts the final count to the ingest inbox. The guts of the module will be supplied by a later PR.

Definition at line 36 of file CentralRepoDataArtifactIngestModule.java.

Member Function Documentation

ProcessResult org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.process ( DataArtifact artifact )

Processes a data artifact.

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

artifact The artifact to process.

Returns: A result code indicating success or failure of the processing.

Implements org.sleuthkit.autopsy.ingest.DataArtifactIngestModule.

Definition at line 41 of file CentralRepoDataArtifactIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK.

void org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.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 47 of file CentralRepoDataArtifactIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createMessage(), org.sleuthkit.autopsy.ingest.IngestServices.getInstance(), org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoIngestModuleFactory.getModuleName(), org.sleuthkit.autopsy.ingest.IngestMessage.MessageType.INFO, and org.sleuthkit.autopsy.ingest.IngestServices.postMessage().

default void org.sleuthkit.autopsy.ingest.IngestModule.startUp ( IngestJobContext context ) throws IngestModuleException

inherited

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

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

Definition at line 68 of file IngestModule.java.

Member Data Documentation

final AtomicLong org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.artifactCounter = new AtomicLong()

private

Definition at line 38 of file CentralRepoDataArtifactIngestModule.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/centralrepository/ingestmodule/CentralRepoDataArtifactIngestModule.java

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation