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

Inherits org.sleuthkit.autopsy.report.ReportModule.

Inherited by org.sleuthkit.autopsy.modules.case_uco.ReportCaseUco, org.sleuthkit.autopsy.modules.stix.STIXReportModule, org.sleuthkit.autopsy.report.GeneralReportModuleAdapter, org.sleuthkit.autopsy.report.ReportBodyFile, org.sleuthkit.autopsy.report.ReportKML, and org.sleuthkit.autopsy.report.taggedhashes.AddTaggedHashesToHashDb.

Public Member Functions

void generateReport (String baseReportDir, ReportProgressPanel progressPanel)
 
default JPanel getConfigurationPanel ()
 
String getDescription ()
 
String getName ()
 
String getRelativeFilePath ()
 

Detailed Description

Definition at line 21 of file GeneralReportModule.java.

Member Function Documentation

void org.sleuthkit.autopsy.report.GeneralReportModule.generateReport ( String  baseReportDir,
ReportProgressPanel  progressPanel 
)

Called to generate the report. Method is responsible for saving the file at the path specified and updating progress via the progressPanel object.

Parameters
baseReportDirBase directory that reports are being stored in. Report should go into baseReportDir + getRelativeFilePath().
progressPanelpanel to update the report's progress with

Implemented in org.sleuthkit.autopsy.modules.stix.STIXReportModule, org.sleuthkit.autopsy.report.taggedhashes.AddTaggedHashesToHashDb, and org.sleuthkit.autopsy.report.GeneralReportModuleAdapter.

default JPanel org.sleuthkit.autopsy.report.ReportModule.getConfigurationPanel ( )
inherited

Returns the configuration panel for the report, which is displayed in the report configuration step of the report wizard.

Returns
Configuration panel or null if the module does not need configuration.

Definition at line 60 of file ReportModule.java.

String org.sleuthkit.autopsy.report.ReportModule.getDescription ( )
inherited

Gets a one-line, user friendly description of the type of report this module generates.

String org.sleuthkit.autopsy.report.ReportModule.getName ( )
inherited

Get the name of the report this module generates.

String org.sleuthkit.autopsy.report.ReportModule.getRelativeFilePath ( )
inherited

Gets the relative path of the report file, if any, generated by this module. The path should be relative to the location that gets passed in to generateReport() (or similar).

Returns
Relative path to where report will be stored. May be null if the module does not produce a report file.

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

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