Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.report.GeneralReportModuleAdapter Class Referenceabstract

Inherits org.sleuthkit.autopsy.report.GeneralReportModule.

Public Member Functions

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

Detailed Description

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

Definition at line 27 of file GeneralReportModuleAdapter.java.

Member Function Documentation

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

Implements org.sleuthkit.autopsy.report.GeneralReportModule.

Definition at line 42 of file GeneralReportModuleAdapter.java.

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

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.datasourcesummaryexport.DataSourceSummaryReport, 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.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 47 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.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
settingsObject which contains report module settings.

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

default boolean org.sleuthkit.autopsy.report.GeneralReportModule.supportsDataSourceSelection ( )
inherited

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, org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport, and org.sleuthkit.autopsy.report.modules.datasourcesummaryexport.DataSourceSummaryReport.

Definition at line 64 of file GeneralReportModule.java.


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

Copyright © 2012-2022 Basis Technology. Generated on: Wed Sep 28 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.