Autopsy  4.16.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator Class Reference

Inherits org.sleuthkit.autopsy.coreutils.ExecUtil.ProcessTerminator.

Public Member Functions

 FileIngestModuleProcessTerminator (IngestJobContext context)
 
 FileIngestModuleProcessTerminator (IngestJobContext context, long maxRunTimeInSeconds)
 
 FileIngestModuleProcessTerminator (IngestJobContext context, boolean useGlobalTimeOut)
 
ProcTerminationCode getTerminationCode ()
 
boolean shouldTerminateProcess ()
 

Private Attributes

final IngestJobContext context
 
ProcTerminationCode terminationCode
 
ExecUtil.TimedProcessTerminator timedTerminator
 

Detailed Description

A process terminator for file ingest modules that checks for ingest job cancellation and optionally checks for process run time in excess of a specified maximum.

Definition at line 29 of file FileIngestModuleProcessTerminator.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.FileIngestModuleProcessTerminator ( IngestJobContext  context)

Constructs a process terminator for a file ingest module.

Parameters
contextThe ingest job context for the ingest module.

Definition at line 40 of file FileIngestModuleProcessTerminator.java.

References org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.context, and org.sleuthkit.autopsy.ingest.ProcTerminationCode.NONE.

org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.FileIngestModuleProcessTerminator ( IngestJobContext  context,
long  maxRunTimeInSeconds 
)

Constructs a process terminator for a file ingest module.

Parameters
contextThe ingest job context for the ingest module.
maxRunTimeInSecondsMaximum allowable run time of process.

Definition at line 51 of file FileIngestModuleProcessTerminator.java.

References org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.context, and org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.timedTerminator.

org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.FileIngestModuleProcessTerminator ( IngestJobContext  context,
boolean  useGlobalTimeOut 
)

Constructs a process terminator for a file ingest module. Adds ability to use global process termination time out.

Parameters
contextThe ingest job context for the ingest module.
useGlobalTimeOutFlag whether to use global process termination timeout.

Definition at line 64 of file FileIngestModuleProcessTerminator.java.

References org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.context, and org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.timedTerminator.

Member Function Documentation

ProcTerminationCode org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.getTerminationCode ( )

Returns process termination code.

Returns
ProcTerminationCode Process termination code.

Definition at line 92 of file FileIngestModuleProcessTerminator.java.

References org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.terminationCode.

boolean org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.shouldTerminateProcess ( )

Member Data Documentation

final IngestJobContext org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.context
private
ProcTerminationCode org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.terminationCode
private
ExecUtil.TimedProcessTerminator org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.timedTerminator
private

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

Copyright © 2012-2020 Basis Technology. Generated on: Tue Sep 22 2020
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.