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

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 ( )
default ReportModuleSettings org.sleuthkit.autopsy.report.ReportModule.getDefaultConfiguration ( )
String org.sleuthkit.autopsy.report.ReportModule.getDescription ( )
String org.sleuthkit.autopsy.report.ReportModule.getName ( )
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.

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport, org.sleuthkit.autopsy.report.modules.kml.KMLReport, org.sleuthkit.autopsy.report.modules.stix.STIXReportModule, org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule, org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport, org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule, org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb, and org.sleuthkit.autopsy.report.GeneralReportModuleAdapter.

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

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

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

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