Autopsy  4.19.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.ingest.IngestStream Interface Reference

Inherited by org.sleuthkit.autopsy.casemodule.DefaultIngestStream, and org.sleuthkit.autopsy.ingest.IngestJobInputStream.

Public Member Functions

void addFiles (List< Long > fileObjectIds) throws IngestStreamClosedException
 
void close ()
 
IngestJob getIngestJob ()
 
boolean isClosed ()
 
void stop ()
 
boolean wasStopped ()
 

Detailed Description

Interface for classes that handle adding files from a data source processor to the ingest pipeline.

Definition at line 27 of file IngestStream.java.

Member Function Documentation

void org.sleuthkit.autopsy.ingest.IngestStream.addFiles ( List< Long >  fileObjectIds) throws IngestStreamClosedException

Adds a set of file object IDs that are ready for ingest.

Parameters
fileObjectIdsList of file object IDs.
Exceptions
IngestStreamClosedException
void org.sleuthkit.autopsy.ingest.IngestStream.close ( )

Closes the ingest stream. Should be called after all files from data source have been sent to the stream.

IngestJob org.sleuthkit.autopsy.ingest.IngestStream.getIngestJob ( )

Get the ingest job associated with this ingest stream.

Returns
The IngestJob.
boolean org.sleuthkit.autopsy.ingest.IngestStream.isClosed ( )

Check whether the ingest stream is closed.

Returns
True if closed, false otherwise.
void org.sleuthkit.autopsy.ingest.IngestStream.stop ( )

Stops the ingest stream. The stream will no longer accept new data and should no longer be used. Will also close the ingest stream.

Referenced by org.sleuthkit.autopsy.casemodule.ImageDSProcessor.cancel().

boolean org.sleuthkit.autopsy.ingest.IngestStream.wasStopped ( )

Check whether the ingest stream was stopped before completion. If this returns true, data should not be written to or read from the stream.

Returns
True if the ingest stream was stopped, false otherwise.

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

Copyright © 2012-2021 Basis Technology. Generated on: Fri Aug 6 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.