org.sleuthkit.autopsy.report.GeneralReportModule Interface Reference

Inherits org.sleuthkit.autopsy.report.ReportModule.

Inherited by 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)
JPanel	getConfigurationPanel ()
String	getDescription ()
String	getName ()
String	getRelativeFilePath ()

Detailed Description

Definition at line 23 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

baseReportDir	Base directory that reports are being stored in. Report should go into baseReportDir + getRelativeFilePath().
progressPanel	panel 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.

JPanel org.sleuthkit.autopsy.report.GeneralReportModule.getConfigurationPanel

(

)

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.

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

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:

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/report/GeneralReportModule.java