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.infrastructure.FileReportModule Interface Reference

Inherits org.sleuthkit.autopsy.report.ReportModule.

Inherited by org.sleuthkit.autopsy.report.modules.file.FileReportText.

Public Member Functions

void addRow (AbstractFile toAdd, List< FileReportDataTypes > columns)
 
void endReport ()
 
void endTable ()
 
default ReportModuleSettings getConfiguration ()
 
default JPanel getConfigurationPanel ()
 
default ReportModuleSettings getDefaultConfiguration ()
 
String getDescription ()
 
String getName ()
 
String getRelativeFilePath ()
 
default void setConfiguration (ReportModuleSettings settings)
 
void startReport (String baseReportDir)
 
void startTable (List< FileReportDataTypes > headers)
 

Detailed Description

A Report Module that reports information on files in a case.

Author
jwallace

Definition at line 30 of file FileReportModule.java.

Member Function Documentation

void org.sleuthkit.autopsy.report.infrastructure.FileReportModule.addRow ( AbstractFile  toAdd,
List< FileReportDataTypes columns 
)

Add the given AbstractFile as a row in the table. Guaranteed to be called between startTable and endTable.

Parameters
toAddthe AbstractFile to be added.
columnsthe columns that should be included
void org.sleuthkit.autopsy.report.infrastructure.FileReportModule.endReport ( )

End the report. Will be called after the entire report has been written.

void org.sleuthkit.autopsy.report.infrastructure.FileReportModule.endTable ( )

Close the table.

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.

default JPanel org.sleuthkit.autopsy.report.ReportModule.getConfigurationPanel ( )
inherited
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().

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.portablecase.PortableCaseReportModule, org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport, org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule, org.sleuthkit.autopsy.report.modules.datasourcesummaryexport.DataSourceSummaryReport, 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

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

void org.sleuthkit.autopsy.report.infrastructure.FileReportModule.startReport ( String  baseReportDir)

Initialize the report which will be stored at the given path.

Parameters
baseReportDirBase directory to store the report file in. Report should go into baseReportDir + getRelativeFilePath().
void org.sleuthkit.autopsy.report.infrastructure.FileReportModule.startTable ( List< FileReportDataTypes headers)

Start the file list table.

Parameters
headersThe columns that should be included in the table.

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

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