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

Inherits org.sleuthkit.autopsy.report.GeneralReportModule.

Public Member Functions

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

Private Member Functions

void initializePanel ()
 

Private Attributes

SaveTaggedHashesToHashDbConfigPanel configPanel
 

Static Private Attributes

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

Detailed Description

Instances of this class plug in to the reporting infrastructure to provide a convenient way to add content hashes to hash set databases.

Definition at line 48 of file SaveTaggedHashesToHashDb.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.SaveTaggedHashesToHashDb ( )

Definition at line 53 of file SaveTaggedHashesToHashDb.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
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.

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.taggedhashes.SaveTaggedHashesToHashDb.generateReport ( GeneralReportSettings  settings,
ReportProgressPanel  progressPanel 
)

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

Implements org.sleuthkit.autopsy.report.GeneralReportModule.

Definition at line 119 of file SaveTaggedHashesToHashDb.java.

References org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.HashDb.addHashes(), org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.COMPLETE, org.sleuthkit.autopsy.report.ReportProgressPanel.complete(), org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.ERROR, org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsByTagName(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getDisplayName(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.HashDb.getHashSetName(), org.sleuthkit.autopsy.coreutils.Logger.getLogger(), org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.getName(), org.sleuthkit.autopsy.casemodule.Case.getServices(), org.sleuthkit.autopsy.report.ReportProgressPanel.getStatus(), org.sleuthkit.autopsy.casemodule.services.Services.getTagsManager(), org.sleuthkit.autopsy.report.ReportProgressPanel.setIndeterminate(), org.sleuthkit.autopsy.report.ReportProgressPanel.start(), and org.sleuthkit.autopsy.report.ReportProgressPanel.updateStatusLabel().

ReportModuleSettings org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.getConfiguration ( )

Get current configuration for this report module.

Returns
Object which contains current report module settings.

Implements org.sleuthkit.autopsy.report.ReportModule.

Definition at line 87 of file SaveTaggedHashesToHashDb.java.

JPanel org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.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 199 of file SaveTaggedHashesToHashDb.java.

ReportModuleSettings org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.getDefaultConfiguration ( )

Get default configuration for this report module.

Returns
Object which contains default report module settings.

Implements org.sleuthkit.autopsy.report.ReportModule.

Definition at line 77 of file SaveTaggedHashesToHashDb.java.

String org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.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 62 of file SaveTaggedHashesToHashDb.java.

String org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.getName ( )

Get the name of the report this module generates.

Implements org.sleuthkit.autopsy.report.ReportModule.

Definition at line 57 of file SaveTaggedHashesToHashDb.java.

Referenced by org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.generateReport().

String org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.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 67 of file SaveTaggedHashesToHashDb.java.

void org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.initializePanel ( )
private

Definition at line 204 of file SaveTaggedHashesToHashDb.java.

void org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.setConfiguration ( ReportModuleSettings  settings)

Set report module configuration.

Parameters
settingsObject which contains report module settings.

Implements org.sleuthkit.autopsy.report.ReportModule.

Definition at line 98 of file SaveTaggedHashesToHashDb.java.

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.

Member Data Documentation

SaveTaggedHashesToHashDbConfigPanel org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.configPanel
private

Definition at line 51 of file SaveTaggedHashesToHashDb.java.

final Logger org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.logger = Logger.getLogger(SaveTaggedHashesToHashDb.class.getName())
staticprivate

Definition at line 50 of file SaveTaggedHashesToHashDb.java.


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

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