Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter Class Reference

Inherits org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.

Public Member Functions

 SnapShotReportWriter (Case currentCase, Path reportFolderPath, String reportName, EventsModelParams zoomState, Date generationDate, BufferedImage snapshot)
 
Path writeReport () throws IOException
 

Protected Member Functions

void fillTemplateAndWrite (final String templateLocation, final String templateName, Object context, final Path outPutFile) throws IOException
 
Case getCurrentCase ()
 
Path getReportFolderPath ()
 
String getReportName ()
 
void writeSnapShotHTMLFile () throws IOException
 

Private Attributes

final BufferedImage image
 
final EventsModelParams zoomState
 

Detailed Description

Generate and write the Timeline snapshot report to disk.

Definition at line 35 of file SnapShotReportWriter.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.SnapShotReportWriter ( Case  currentCase,
Path  reportFolderPath,
String  reportName,
EventsModelParams  zoomState,
Date  generationDate,
BufferedImage  snapshot 
)

Constructor

Parameters
currentCaseThe Case to write a report for.
reportFolderPathThe Path to the folder that will contain the report.
reportNameThe name of the report.
zoomStateThe ZoomState in effect when the snapshot was taken.
generationDateThe generation Date of the report.
snapshotA snapshot of the view to include in the report.

Definition at line 52 of file SnapShotReportWriter.java.

References org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.zoomState.

Member Function Documentation

void org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.fillTemplateAndWrite ( final String  templateLocation,
final String  templateName,
Object  context,
final Path  outPutFile 
) throws IOException
protectedinherited

Fill in the mustache template at the given location using the values from the given context object and save it to the given outPutFile.

Parameters
templateLocationThe location of the template. suitible for use with Class.getResourceAsStream
templateNameThe name of the tempalte. (Used by mustache to cache templates?)
contextThe contect to use to fill in the template values.
outPutFileThe filled in tempalte will be saced at this Path.
Exceptions
IOExceptionIf there is a problem saving the filled in template to disk.

Definition at line 186 of file UiSnapShotReportWriter.java.

Referenced by org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeIndexHTML(), org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile(), org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeSummaryHTML().

Case org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getCurrentCase ( )
protectedinherited
Path org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportFolderPath ( )
protectedinherited
String org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportName ( )
protectedinherited
Path org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeReport ( ) throws IOException
inherited

Generate and write the report to disk.

Returns
The Path to the "main file" of the report. This is the file that Autopsy shows in the results view when the Reports Node is selected in the DirectoryTree.
Exceptions
IOExceptionIf there is a problem writing the report.

Definition at line 84 of file UiSnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.copyResources(), org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeIndexHTML(), org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeSummaryHTML().

Referenced by org.sleuthkit.autopsy.communications.VisualizationPanel.createReport().

void org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile ( ) throws IOException
protected

Member Data Documentation

final BufferedImage org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.image
private

Definition at line 38 of file SnapShotReportWriter.java.

final EventsModelParams org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.zoomState
private

The documentation for this class 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.