org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter Class Reference

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

Classes
class	ReportWriterHelper

Public Member Functions
	CommSnapShotReportWriter (Case currentCase, Path reportFolderPath, String reportName, Date generationDate, BufferedImage snapshot, CommunicationsFilter filter)
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 CommunicationsFilter	filter
final BufferedImage	image

Detailed Description

Generate and write the Communication snapshot report to disk.

Definition at line 48 of file CommSnapShotReportWriter.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.CommSnapShotReportWriter	(	Case	currentCase,
		Path	reportFolderPath,
		String	reportName,
		Date	generationDate,
		BufferedImage	snapshot,
		CommunicationsFilter	filter
	)

Constructor

Parameters

currentCase	The Case to write a report for.
reportFolderPath	The Path to the folder that will contain the report.
reportName	The name of the report.
generationDate	The generation Date of the report.
snapshot	A snapshot of the view to include in the report.

Definition at line 63 of file CommSnapShotReportWriter.java.

References org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.filter.

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

templateLocation	The location of the template. suitible for use with Class.getResourceAsStream
templateName	The name of the tempalte. (Used by mustache to cache templates?)
context	The contect to use to fill in the template values.
outPutFile	The filled in tempalte will be saced at this Path.

Exceptions

IOException

If there is a problem saving the filled in template to disk.

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

Get the case for this report.

Returns

Current case object

Definition at line 120 of file UiSnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.currentCase.

Referenced by org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.writeSnapShotHTMLFile().

Path org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportFolderPath ( )

protectedinherited

Get the folder path for the report.

Returns

Report folder path

Definition at line 111 of file UiSnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.reportFolderPath.

Referenced by org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.writeSnapShotHTMLFile().

String org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportName ( )

protectedinherited

Get the name for the report.

Returns

Returns the reportName

Definition at line 102 of file UiSnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.reportName.

Referenced by org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.writeSnapShotHTMLFile().

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

IOException

If there is a problem writing the report.

Definition at line 86 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.communications.snapshot.CommSnapShotReportWriter.writeSnapShotHTMLFile ( ) throws IOException

protected

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

Exceptions

IOException

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

Definition at line 79 of file CommSnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.fillTemplateAndWrite(), org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getCurrentCase(), org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportFolderPath(), org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportName(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

Member Data Documentation

final CommunicationsFilter org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.filter

private

Definition at line 51 of file CommSnapShotReportWriter.java.

Referenced by org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.CommSnapShotReportWriter().

final BufferedImage org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.image

private

Definition at line 50 of file CommSnapShotReportWriter.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/communications/snapshot/CommSnapShotReportWriter.java