Autopsy  4.1
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.timeline.snapshot.SnapShotReportWriter Class Reference

Public Member Functions

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

Private Member Functions

void copyResources () throws IOException
void fillTemplateAndWrite (final String templateLocation, final String templateName, Object context, final Path outPutFile) throws IOException
Path writeIndexHTML () throws IOException
void writeSnapShotHTMLFile () throws IOException
void writeSummaryHTML () throws IOException

Private Attributes

final Case currentCase
final Date generationDate
final BufferedImage image
final ReportBranding reportBranding
final Path reportFolderPath
final String reportName
final ZoomParams zoomParams

Static Private Attributes

static final MustacheFactory mf = new DefaultMustacheFactory()

Detailed Description

Generate and write the Timeline snapshot report to disk.

Definition at line 47 of file

Constructor & Destructor Documentation

org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.SnapShotReportWriter ( Case  currentCase,
Path  reportFolderPath,
String  reportName,
ZoomParams  zoomParams,
Date  generationDate,
BufferedImage  snapshot 


currentCaseThe Case to write a report for.
reportFolderPathThe Path to the folder that will contain the report.
reportNameThe name of the report.
zoomParamsThe ZoomParams 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 76 of file

References org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.currentCase, org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.generationDate, org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.reportFolderPath, org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.reportName, and org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.zoomParams.

Member Function Documentation

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

Copy static resources (static html, css, images, etc) to the reports folder.

IOExceptionIf there is a problem copying the resources.

Definition at line 193 of file

References, and

Referenced by org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeReport().

void org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.fillTemplateAndWrite ( final String  templateLocation,
final String  templateName,
Object  context,
final Path  outPutFile 
) throws IOException

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

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.
IOExceptionIf there is a problem saving the filled in template to disk.

Definition at line 179 of file

Referenced by org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeIndexHTML(), org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSummaryHTML().

Path org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeIndexHTML ( ) throws IOException

Generate and write the main html page with frames for navigation on the left and content on the right.

The Path of the written html file.
IOExceptionIf there is a problem writing the html file to disk.

Definition at line 135 of file

References org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.fillTemplateAndWrite().

Referenced by org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeReport().

Path org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeReport ( ) throws IOException

Generate and write the report to disk.

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.
IOExceptionIf there is a problem writing the report.

Definition at line 96 of file

References org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.copyResources(), org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeIndexHTML(), org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSummaryHTML().

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

Generate and write the html page that shows the snapshot and the state of the ZoomParams

IOExceptionIf there is a problem writing the html file to disk.

Definition at line 116 of file

References org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.fillTemplateAndWrite(), and org.sleuthkit.autopsy.timeline.zooming.ZoomParams.getTimeRange().

Referenced by org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeReport().

void org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSummaryHTML ( ) throws IOException
  • Generate and write the summary of the current case for this report.
IOExceptionIf there is a problem writing the html file to disk.

Definition at line 151 of file

References org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.fillTemplateAndWrite(), org.sleuthkit.autopsy.ingest.IngestManager.getInstance(), and org.sleuthkit.autopsy.ingest.IngestManager.isIngestRunning().

Referenced by org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeReport().

Member Data Documentation

final Case org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.currentCase
final Date org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.generationDate
final BufferedImage org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.image

Definition at line 61 of file

final MustacheFactory = new DefaultMustacheFactory()
staticprivate template factory.

Definition at line 52 of file

final ReportBranding org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.reportBranding

Definition at line 57 of file

final Path org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.reportFolderPath
final String org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.reportName
final ZoomParams org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.zoomParams

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

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