org.sleuthkit.autopsy.report.infrastructure.ReportGenerator Class Reference

Public Member Functions
	ReportGenerator (String configName, ReportProgressIndicator progressIndicator)
void	generateReports ()

Static Public Member Functions
static String	getReportsDirectory ()

Private Member Functions
void	displayReportErrors ()
void	generateFileListReport (FileReportModule fileReportModule, FileReportSettings fileReportSettings) throws IOException
void	generateGeneralReport (GeneralReportModule generalReportModule) 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)

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 61 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

configName	The name of the reporting configuration to use.
progressIndicator	The report progress indicator.

Definition at line 103 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

Definition at line 407 of file ReportGenerator.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getDisplayName(), and org.sleuthkit.autopsy.casemodule.Case.getReportDirectory().

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateFileListReport(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateGeneralReport(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generatePortableCaseReport(), and org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateTableReport().

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 85 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

Run the FileReportModules using a SwingWorker.

Parameters

fileReportModule
fileReportSettings	settings for the file report

Definition at line 315 of file ReportGenerator.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.COMPLETE, org.sleuthkit.autopsy.report.ReportProgressPanel.complete(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.createReportDirectory(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.getFiles(), org.sleuthkit.autopsy.report.ReportProgressPanel.getStatus(), org.sleuthkit.autopsy.report.ReportProgressPanel.increment(), org.sleuthkit.autopsy.report.ReportProgressPanel.setIndeterminate(), org.sleuthkit.autopsy.report.ReportProgressPanel.setMaximumProgress(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.setupProgressPanel(), org.sleuthkit.autopsy.report.ReportProgressPanel.start(), and org.sleuthkit.autopsy.report.ReportProgressPanel.updateStatusLabel().

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

void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateGeneralReport ( GeneralReportModule  generalReportModule ) throws IOException

private

Run the GeneralReportModules using a SwingWorker.

Definition at line 281 of file ReportGenerator.java.

References org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.createReportDirectory(), and org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.setupProgressPanel().

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

void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generatePortableCaseReport ( PortableCaseReportModule  portableCaseReportModule, PortableCaseReportModuleSettings  settings  ) throws IOException

private

Run the Portable Case Report Module

Definition at line 368 of file ReportGenerator.java.

References org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.createReportDirectory(), and org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.setupProgressPanel().

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

void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateReports

(

)

Generates the reports specified by the reporting configuration passed in via the constructor.

Definition at line 127 of file ReportGenerator.java.

References org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.displayReportErrors(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateFileListReport(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateGeneralReport(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generatePortableCaseReport(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateTableReport(), org.sleuthkit.autopsy.report.ReportModule.getDefaultConfiguration(), org.sleuthkit.autopsy.report.ReportModule.setConfiguration(), and org.sleuthkit.autopsy.report.ReportProgressPanel.updateStatusLabel().

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

void org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateTableReport ( TableReportModule  tableReport, TableReportSettings  tableReportSettings  ) throws IOException

private

Run the TableReportModules using a SwingWorker.

Parameters

tableReport
tableReportSettings	settings for the table report

Definition at line 295 of file ReportGenerator.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.COMPLETE, org.sleuthkit.autopsy.report.ReportProgressPanel.complete(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.createReportDirectory(), and org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.setupProgressPanel().

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

List<AbstractFile> org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.getFiles ( )

private

Get all files in the image.

Returns

Definition at line 381 of file ReportGenerator.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase(), and org.sleuthkit.autopsy.report.ReportProgressPanel.updateStatusLabel().

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

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 77 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

Definition at line 394 of file ReportGenerator.java.

References org.sleuthkit.autopsy.report.ReportModule.getName(), and org.sleuthkit.autopsy.report.ReportModule.getRelativeFilePath().

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateFileListReport(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateGeneralReport(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generatePortableCaseReport(), and org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateTableReport().

Member Data Documentation

final String org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.configName

private

Definition at line 67 of file ReportGenerator.java.

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

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

private

Definition at line 69 of file ReportGenerator.java.

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

staticprivate

Definition at line 63 of file ReportGenerator.java.

final ReportProgressPanel org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.progressIndicator

private

Definition at line 64 of file ReportGenerator.java.

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

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

staticprivate

Definition at line 66 of file ReportGenerator.java.

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

private

Definition at line 65 of file ReportGenerator.java.

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

staticprivate

Definition at line 68 of file ReportGenerator.java.

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

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/report/infrastructure/ReportGenerator.java