Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.report.infrastructure.ReportGenerator Class Reference

Public Member Functions

 ReportGenerator (String configName, ReportProgressIndicator progressIndicator)
 
void generateReports () throws ReportGenerationException
 
void generateReports (Map< String, ReportModule > modules) throws ReportGenerationException
 

Static Public Member Functions

static String getReportsDirectory ()
 

Private Member Functions

void displayReportErrors ()
 
void generateFileListReport (FileReportModule fileReportModule, FileReportSettings fileReportSettings) throws IOException
 
void generateGeneralReport (GeneralReportModule generalReportModule, GeneralReportSettings reportSettings) throws IOException
 
void generatePortableCaseReport (PortableCaseReportModule portableCaseReportModule, PortableCaseReportModuleSettings settings) throws IOException
 
void generateTableReport (TableReportModule tableReport, TableReportSettings tableReportSettings) throws IOException
 
List< AbstractFile > getFiles ()
 
void setupProgressPanel (ReportModule module, String reportDir)
 
boolean shouldFilterFromReport (AbstractFile file, FileReportSettings fileReportSettings)
 

Static Private Member Functions

static String createReportDirectory (ReportModule module) throws IOException
 

Private Attributes

final String configName
 
List< String > errorList = new ArrayList<>()
 
final ReportProgressPanel progressIndicator
 
final ReportGenerationPanel reportGenerationPanel
 

Static Private Attributes

static final Logger logger = Logger.getLogger(ReportGenerator.class.getName())
 
static final String REPORT_PATH_FMT_STR = "%s" + File.separator + "%s %s %s" + File.separator
 
static final String REPORTS_DIR = "Reports"
 

Detailed Description

A report generator that generates one or more reports by running user-selected report modules.

Definition at line 63 of file ReportGenerator.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.ReportGenerator ( String  configName,
ReportProgressIndicator  progressIndicator 
)

Constructs a report generator that generates one or more reports by running user-selected report modules and uses a report progress indicator to display progress.

Parameters
configNameThe name of the reporting configuration to use.
progressIndicatorThe report progress indicator.

Definition at line 105 of file ReportGenerator.java.

References org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.configName, and org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.progressIndicator.

Member Function Documentation

static String org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.createReportDirectory ( ReportModule  module) throws IOException
staticprivate
void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.displayReportErrors ( )
private

Displays a list of errors emitted by report modules during report generation using this report generator's report progress indicator.

Definition at line 87 of file ReportGenerator.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.updateStatusLabel().

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

void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateFileListReport ( FileReportModule  fileReportModule,
FileReportSettings  fileReportSettings 
) throws IOException
private
void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateGeneralReport ( GeneralReportModule  generalReportModule,
GeneralReportSettings  reportSettings 
) throws IOException
private
void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generatePortableCaseReport ( PortableCaseReportModule  portableCaseReportModule,
PortableCaseReportModuleSettings  settings 
) throws IOException
private
void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateReports ( ) throws ReportGenerationException

Generates the reports specified by the reporting configuration passed in via the constructor. Does lookup of all existing report modules.

Exceptions
ReportGenerationExceptionif an error occurred while generating the report.

Definition at line 132 of file ReportGenerator.java.

References org.sleuthkit.autopsy.python.FactoryClassNameNormalizer.normalize().

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportWizardAction.doReportWizard(), and org.sleuthkit.autopsy.commandlineingest.CommandLineIngestManager.JobProcessingTask.run().

void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateReports ( Map< String, ReportModule modules) throws ReportGenerationException
void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateTableReport ( TableReportModule  tableReport,
TableReportSettings  tableReportSettings 
) throws IOException
private
List<AbstractFile> org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.getFiles ( )
private
static String org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.getReportsDirectory ( )
static

Gets the name of the reports directory within the case direcotry hierarchy.

Returns
The directory name.

Definition at line 79 of file ReportGenerator.java.

References org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.REPORTS_DIR.

Referenced by org.sleuthkit.autopsy.report.ReportBranding.ReportBranding().

void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.setupProgressPanel ( ReportModule  module,
String  reportDir 
)
private
boolean org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.shouldFilterFromReport ( AbstractFile  file,
FileReportSettings  fileReportSettings 
)
private

Member Data Documentation

final String org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.configName
private
List<String> org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.errorList = new ArrayList<>()
private

Definition at line 71 of file ReportGenerator.java.

final Logger org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.logger = Logger.getLogger(ReportGenerator.class.getName())
staticprivate

Definition at line 65 of file ReportGenerator.java.

final ReportProgressPanel org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.progressIndicator
private
final String org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.REPORT_PATH_FMT_STR = "%s" + File.separator + "%s %s %s" + File.separator
staticprivate

Definition at line 68 of file ReportGenerator.java.

final ReportGenerationPanel org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.reportGenerationPanel
private

Definition at line 67 of file ReportGenerator.java.

final String org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.REPORTS_DIR = "Reports"
staticprivate

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

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