Inherited by org.sleuthkit.autopsy.report.GeneralReportModule, org.sleuthkit.autopsy.report.infrastructure.FileReportModule, org.sleuthkit.autopsy.report.infrastructure.TableReportModule, and org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.

Public Member Functions
default ReportModuleSettings	getConfiguration ()

default JPanel	getConfigurationPanel ()

default ReportModuleSettings	getDefaultConfiguration ()

String	getDescription ()

String	getName ()

String	getRelativeFilePath ()

default void	setConfiguration (ReportModuleSettings settings)

Detailed Description

Interface for report modules that plug in to the reporting infrastructure.

Definition at line 30 of file ReportModule.java.

Member Function Documentation

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

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.

default JPanel org.sleuthkit.autopsy.report.ReportModule.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.report.modules.kml.KMLReport, org.sleuthkit.autopsy.report.modules.stix.STIXReportModule, org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb, org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport, org.sleuthkit.autopsy.report.modules.html.HTMLReport, org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule, and org.sleuthkit.autopsy.report.GeneralReportModuleAdapter.

Definition at line 61 of file ReportModule.java.

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

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().

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

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

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

Get the name of the report this module generates.

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportVisualPanel1.ModuleCellRenderer.getListCellRendererComponent(), and org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.setupProgressPanel().

String org.sleuthkit.autopsy.report.ReportModule.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.

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

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

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 interface was generated from the following file:

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

Public Member Functions

Detailed Description

Member Function Documentation