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

context

The 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

context	The ingest job context for the ingest module.
maxRunTimeInSeconds	Maximum 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

context	The ingest job context for the ingest module.
useGlobalTimeOut	Flag 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

(

)

Decides whether or not to terminate a process being run by a ExcUtil.execute() methods.

Returns

True or false.

Implements org.sleuthkit.autopsy.coreutils.ExecUtil.ProcessTerminator.

Definition at line 72 of file FileIngestModuleProcessTerminator.java.

References org.sleuthkit.autopsy.ingest.ProcTerminationCode.CANCELATION, org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled(), org.sleuthkit.autopsy.ingest.ProcTerminationCode.TIME_OUT, and org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.timedTerminator.

Member Data Documentation

final IngestJobContext org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.context

private

Definition at line 31 of file FileIngestModuleProcessTerminator.java.

Referenced by org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.FileIngestModuleProcessTerminator().

ProcTerminationCode org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.terminationCode

private

Definition at line 33 of file FileIngestModuleProcessTerminator.java.

Referenced by org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.getTerminationCode().

ExecUtil.TimedProcessTerminator org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.timedTerminator

private

Definition at line 32 of file FileIngestModuleProcessTerminator.java.

Referenced by org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.FileIngestModuleProcessTerminator(), and org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.shouldTerminateProcess().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/ingest/FileIngestModuleProcessTerminator.java