Autopsy  4.19.0
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.keywordsearch.ExtractAllTermsReport, org.sleuthkit.autopsy.report.GeneralReportModuleAdapter, org.sleuthkit.autopsy.report.modules.bodyfile.BodyFileReport, org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule, org.sleuthkit.autopsy.report.modules.kml.KMLReport, org.sleuthkit.autopsy.report.modules.stix.STIXReportModule, and org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.

Public Member Functions

default void generateReport (String baseReportDir, ReportProgressPanel progressPanel)
 
default void generateReport (GeneralReportSettings settings, ReportProgressPanel progressPanel)
 
default ReportModuleSettings getConfiguration ()
 
default JPanel getConfigurationPanel ()
 
default ReportModuleSettings getDefaultConfiguration ()
 
String getDescription ()
 
String getName ()
 
String getRelativeFilePath ()
 
default void setConfiguration (ReportModuleSettings settings)
 
default boolean supportsDataSourceSelection ()
 

Detailed Description

Definition at line 21 of file GeneralReportModule.java.

Member Function Documentation

default 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
Deprecated:
Use generateReport(GeneralReportSettings settings, ReportProgressPanel progressPanel) instead. The baseReportDir is stored in the settings instance.

Implemented in org.sleuthkit.autopsy.report.GeneralReportModuleAdapter.

Definition at line 36 of file GeneralReportModule.java.

Referenced by org.sleuthkit.autopsy.report.GeneralReportModule.generateReport().

default void org.sleuthkit.autopsy.report.GeneralReportModule.generateReport ( GeneralReportSettings  settings,
ReportProgressPanel  progressPanel 
)

Called to generate the report. Method is responsible for saving the file and updating progress via the progressPanel object. Configuration parameters are passed in the settings class, most notably the directory to save the report. Modules should try to respond to all configuration parameters.

Parameters
settingsConfiguration parameters to customize the report generation process
progressPanelpanel to update the report's progress with

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

Definition at line 52 of file GeneralReportModule.java.

References org.sleuthkit.autopsy.report.GeneralReportModule.generateReport().

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.

default JPanel org.sleuthkit.autopsy.report.ReportModule.getConfigurationPanel ( )
inherited
default ReportModuleSettings org.sleuthkit.autopsy.report.ReportModule.getDefaultConfiguration ( )
inherited
String org.sleuthkit.autopsy.report.ReportModule.getDescription ( )
inherited
String org.sleuthkit.autopsy.report.ReportModule.getName ( )
inherited
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. 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)
inherited
default boolean org.sleuthkit.autopsy.report.GeneralReportModule.supportsDataSourceSelection ( )

Determines if the module supports report generation on a subset of data sources in a case. Defaults to false. The data source selections are stored in the GeneralReportSettings instance.

Returns
True if the module can be configured to run on a subset of data sources.

Implemented in org.sleuthkit.autopsy.report.modules.kml.KMLReport, org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule, and org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.

Definition at line 64 of file GeneralReportModule.java.


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

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