org.sleuthkit.autopsy.report.GeneralReportModuleAdapter Class Reference

Inherits org.sleuthkit.autopsy.report.GeneralReportModule.

Public Member Functions
abstract void	generateReport (String baseReportDir, ReportProgressPanel progressPanel)
default ReportModuleSettings	getConfiguration ()
JPanel	getConfigurationPanel ()
default ReportModuleSettings	getDefaultConfiguration ()
abstract String	getDescription ()
abstract String	getName ()
String	getRelativeFilePath ()
default void	setConfiguration (ReportModuleSettings settings)

Detailed Description

An adapter that provides no-op implementations of various GeneralReportModule methods.

Definition at line 27 of file GeneralReportModuleAdapter.java.

Member Function Documentation

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

abstract

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

Implements org.sleuthkit.autopsy.report.GeneralReportModule.

default ReportModuleSettings org.sleuthkit.autopsy.report.ReportModule.getConfiguration ( )

inherited

Get current configuration for this report module.

Returns

Object which contains current report module settings.

Implemented in org.sleuthkit.autopsy.report.modules.stix.STIXReportModule, org.sleuthkit.autopsy.report.modules.html.HTMLReport, and org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.

Definition at line 79 of file ReportModule.java.

JPanel org.sleuthkit.autopsy.report.GeneralReportModuleAdapter.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.

Implements org.sleuthkit.autopsy.report.ReportModule.

Definition at line 44 of file GeneralReportModuleAdapter.java.

default ReportModuleSettings org.sleuthkit.autopsy.report.ReportModule.getDefaultConfiguration ( )

inherited

Get default configuration for this report module.

Returns

Object which contains default report module settings.

Implemented in org.sleuthkit.autopsy.report.modules.stix.STIXReportModule, org.sleuthkit.autopsy.report.modules.html.HTMLReport, and org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.

Definition at line 70 of file ReportModule.java.

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateReports().

abstract String org.sleuthkit.autopsy.report.GeneralReportModuleAdapter.getDescription ( )

abstract

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

Implements org.sleuthkit.autopsy.report.ReportModule.

abstract String org.sleuthkit.autopsy.report.GeneralReportModuleAdapter.getName ( )

abstract

Get the name of the report this module generates.

Implements org.sleuthkit.autopsy.report.ReportModule.

String org.sleuthkit.autopsy.report.GeneralReportModuleAdapter.getRelativeFilePath

(

)

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. Return an empty string if the location passed to generateReport() is the output location. Return null to indicate that there is no report file.

Implements org.sleuthkit.autopsy.report.ReportModule.

Definition at line 36 of file GeneralReportModuleAdapter.java.

default void org.sleuthkit.autopsy.report.ReportModule.setConfiguration ( ReportModuleSettings  settings )

inherited

Set report module configuration.

Parameters

settings

Object which contains report module settings.

Implemented in org.sleuthkit.autopsy.report.modules.stix.STIXReportModule, org.sleuthkit.autopsy.report.modules.html.HTMLReport, and org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.

Definition at line 88 of file ReportModule.java.

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateReports().

---

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

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