org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.

Classes
class	IngestJobTotals

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

Static Public Member Functions
static boolean	isMimeTypeDetectable (String mimeType)

Private Member Functions
void	createInterestingFileHit (AbstractFile file, FileType fileType)
FileType	detectUserDefinedFileType (AbstractFile file) throws CustomFileTypesManager.CustomFileTypesException

Static Private Member Functions
static synchronized void	addToTotals (long jobId, long matchTimeInc)

Private Attributes
FileTypeDetector	fileTypeDetector
long	jobId

Static Private Attributes
static final Logger	logger = Logger.getLogger(FileTypeIdIngestModule.class.getName())
static final IngestModuleReferenceCounter	refCounter = new IngestModuleReferenceCounter()
static final HashMap< Long, IngestJobTotals >	totalsForIngestJobs = new HashMap<>()

Detailed Description

Detects the type of a file based on signature (magic) values. Posts results to the blackboard.

Definition at line 49 of file FileTypeIdIngestModule.java.

Member Function Documentation

static synchronized void org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.addToTotals ( long  jobId, long  matchTimeInc  )

staticprivate

Update the match time total and increment number of files processed for this ingest job.

Parameters

jobId	The ingest job identifier.
matchTimeInc	Amount of time to add.

Definition at line 207 of file FileTypeIdIngestModule.java.

void org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.createInterestingFileHit ( AbstractFile  file, FileType  fileType  )

private

Create an Interesting File hit using the specified file type rule.

Parameters

file	The file from which to generate an artifact.
fileType	The file type rule for categorizing the hit.

Definition at line 148 of file FileTypeIdIngestModule.java.

References org.sleuthkit.autopsy.casemodule.services.Services.getBlackboard(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getServices(), and org.sleuthkit.autopsy.casemodule.services.Blackboard.indexArtifact().

FileType org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.detectUserDefinedFileType ( AbstractFile  file ) throws CustomFileTypesManager.CustomFileTypesException

private

Determines whether or not a file matches a user-defined custom file type.

Parameters

file	The file to test.

Returns

The file type if a match is found; otherwise null.

Exceptions

CustomFileTypesException

If there is an issue getting an instance of CustomFileTypesManager.

Definition at line 127 of file FileTypeIdIngestModule.java.

static boolean org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.isMimeTypeDetectable ( String  mimeType )

static

Validate if a given mime type is in the detector's registry.

Deprecated:

Use FileTypeDetector.mimeTypeIsDetectable(String mimeType) instead.

Parameters

mimeType

Full string of mime type, e.g. "text/html"

Returns

true if detectable

Definition at line 67 of file FileTypeIdIngestModule.java.

References org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector.isDetectable().

ProcessResult org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.process

(

AbstractFile

file

)

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

Parameters

file	The file to analyze.

Returns

A result code indicating success or failure of the processing.

Attempt to detect the file type. Do it within an exception firewall, so that any issues with reading file content or complaints from tika do not take the module down.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

Definition at line 95 of file FileTypeIdIngestModule.java.

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

void org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.shutDown

(

)

Invoked by Autopsy when an ingest job is completed (either because the data has been analyzed or because the job was canceled - check IngestJobContext.fileIngestIsCancelled()), 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.

If this is the instance of this module for this ingest job, post a summary message to the ingest messages box.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

Definition at line 171 of file FileTypeIdIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createMessage(), org.sleuthkit.autopsy.ingest.IngestModuleReferenceCounter.decrementAndGet(), org.sleuthkit.autopsy.ingest.IngestServices.getInstance(), org.sleuthkit.autopsy.ingest.IngestMessage.MessageType.INFO, and org.sleuthkit.autopsy.ingest.IngestServices.postMessage().

void org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.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 process() and shutDown() are logged, but do not stop processing of the data source.

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 84 of file FileTypeIdIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestModuleReferenceCounter.incrementAndGet().

Member Data Documentation

FileTypeDetector org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.fileTypeDetector

private

Definition at line 55 of file FileTypeIdIngestModule.java.

long org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.jobId

private

Definition at line 52 of file FileTypeIdIngestModule.java.

final Logger org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.logger = Logger.getLogger(FileTypeIdIngestModule.class.getName())

staticprivate

Definition at line 51 of file FileTypeIdIngestModule.java.

final IngestModuleReferenceCounter org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.refCounter = new IngestModuleReferenceCounter()

staticprivate

Definition at line 54 of file FileTypeIdIngestModule.java.

final HashMap<Long, IngestJobTotals> org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.totalsForIngestJobs = new HashMap<>()

staticprivate

Definition at line 53 of file FileTypeIdIngestModule.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/modules/filetypeid/FileTypeIdIngestModule.java