Inherits org.sleuthkit.autopsy.report.GeneralReportModule.

Public Member Functions
default void	generateReport (String baseReportDir, ReportProgressPanel progressPanel)

void	generateReport (GeneralReportSettings settings, ReportProgressPanel progressPanel)

default ReportModuleSettings	getConfiguration ()

JPanel	getConfigurationPanel ()

default ReportModuleSettings	getDefaultConfiguration ()

String	getDescription ()

String	getName ()

String	getRelativeFilePath ()

default void	setConfiguration (ReportModuleSettings settings)

boolean	supportsDataSourceSelection ()

Static Public Member Functions
static synchronized CaseUcoReportModule	getDefault ()

static String	getReportFileName ()

Private Member Functions
	CaseUcoReportModule ()

void	performDepthFirstSearch (Content dataSource, CaseUcoReportGenerator generator) throws IOException, TskCoreException

void	warnIngest (ReportProgressPanel progressPanel)

Static Private Attributes
static final String	EXTENSION = "json-ld"

static final Logger	logger = Logger.getLogger(CaseUcoReportModule.class.getName())

static final String	REPORT_FILE_NAME = "CASE_UCO_output"

static final CaseUcoReportModule	SINGLE_INSTANCE = new CaseUcoReportModule()

static final Set< Short >	SUPPORTED_TYPES

Detailed Description

CaseUcoReportModule generates a report in CASE-UCO format. This module will write all files and data sources to the report.

Definition at line 51 of file CaseUcoReportModule.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.CaseUcoReportModule ( )

private

Definition at line 67 of file CaseUcoReportModule.java.

Member Function Documentation

default void org.sleuthkit.autopsy.report.GeneralReportModule.generateReport	(	String	baseReportDir,
		ReportProgressPanel	progressPanel
	)

inherited

Called to generate the report. Method is responsible for saving the file at the path specified and updating progress via the progressPanel object.

Parameters

baseReportDir	Base directory that reports are being stored in. Report should go into baseReportDir + getRelativeFilePath().
progressPanel	panel 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().

void org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.generateReport	(	GeneralReportSettings	settings,
		ReportProgressPanel	progressPanel
	)

Generates a CASE-UCO format report for all files in the Case.

Parameters

settings	Report settings.
progressPanel	panel to update the report's progress

Implements org.sleuthkit.autopsy.report.GeneralReportModule.

Definition at line 127 of file CaseUcoReportModule.java.

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.

JPanel org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.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 81 of file CaseUcoReportModule.java.

static synchronized CaseUcoReportModule org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.getDefault ( )

static

Definition at line 71 of file CaseUcoReportModule.java.

References org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.SINGLE_INSTANCE.

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.stix.STIXReportModule, 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.modules.caseuco.CaseUcoReportModule.getDescription ( )

Gets a one-line, user friendly description of the type of report this module generates.

Implements org.sleuthkit.autopsy.report.ReportModule.

Definition at line 91 of file CaseUcoReportModule.java.

String org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.getName ( )

Get the name of the report this module generates.

Implements org.sleuthkit.autopsy.report.ReportModule.

Definition at line 76 of file CaseUcoReportModule.java.

String org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.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 86 of file CaseUcoReportModule.java.

References org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.EXTENSION.

static String org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.getReportFileName ( )

static

Returns CASE-UCO report file name

Returns: the REPORT_FILE_NAME

Definition at line 100 of file CaseUcoReportModule.java.

References org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.REPORT_FILE_NAME.

void org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.performDepthFirstSearch	(	Content	dataSource,
		CaseUcoReportGenerator	generator
	)		throws IOException, TskCoreException

private

Perform DFS on the data sources tree, which will search it in entirety. This traversal is more memory efficient than BFS (Breadth first search).

Definition at line 212 of file CaseUcoReportModule.java.

Referenced by org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.generateReport().

default void org.sleuthkit.autopsy.report.ReportModule.setConfiguration ( ReportModuleSettings settings )

inherited

Set report module configuration.

Parameters

settings Object which contains 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 88 of file ReportModule.java.

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

boolean org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.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.

Implements org.sleuthkit.autopsy.report.GeneralReportModule.

Definition at line 105 of file CaseUcoReportModule.java.

void org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.warnIngest ( ReportProgressPanel progressPanel )

private

Warn the user if ingest is still ongoing.

Definition at line 202 of file CaseUcoReportModule.java.

References org.sleuthkit.autopsy.ingest.IngestManager.getInstance(), org.sleuthkit.autopsy.ingest.IngestManager.isIngestRunning(), and org.sleuthkit.autopsy.report.ReportProgressPanel.updateStatusLabel().

Referenced by org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.generateReport().

Member Data Documentation

final String org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.EXTENSION = "json-ld"

staticprivate

Definition at line 64 of file CaseUcoReportModule.java.

Referenced by org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.getRelativeFilePath().

final Logger org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.logger = Logger.getLogger(CaseUcoReportModule.class.getName())

staticprivate

Definition at line 53 of file CaseUcoReportModule.java.

final String org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.REPORT_FILE_NAME = "CASE_UCO_output"

staticprivate

Definition at line 63 of file CaseUcoReportModule.java.

Referenced by org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.generateReport(), and org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.getReportFileName().

final CaseUcoReportModule org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.SINGLE_INSTANCE = new CaseUcoReportModule()

staticprivate

Definition at line 54 of file CaseUcoReportModule.java.

Referenced by org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.getDefault().

final Set<Short> org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.SUPPORTED_TYPES

staticprivate

Initial value:

= new HashSet<Short>() {{
        add(TskData.TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_UNDEF.getValue());
        add(TskData.TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_REG.getValue());
        add(TskData.TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_VIRT.getValue());
    }}

Definition at line 57 of file CaseUcoReportModule.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/report/modules/caseuco/CaseUcoReportModule.java

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation