org.sleuthkit.autopsy.report.ReportBranding Class Reference

Inherits org.sleuthkit.autopsy.report.ReportBrandingProviderI.

Public Member Functions
	ReportBranding ()
String	getAgencyLogoPath ()
String	getGeneratorLogoPath ()
String	getReportFooter ()
String	getReportsBrandingDir ()
String	getReportTitle ()
void	setAgencyLogoPath (String path)
void	setGeneratorLogoPath (String path)
void	setReportFooter (String footer)
void	setReportTitle (String title)

Static Public Attributes
static final String	AGENCY_LOGO_PATH_PROP = "AgencyLogoPath"
static final String	MODULE_NAME = ReportBranding.class.getSimpleName()

Private Member Functions
void	extractDefaultGeneratorLogo ()

Private Attributes
String	defaultGeneratorLogoPath
String	reportsBrandingDir

Static Private Attributes
static final String	DEFAULT_GENERATOR_LOGO = "/org/sleuthkit/autopsy/report/images/default_generator_logo.png"
static final String	DEFAULT_REPORT_FOOTER
static final String	DEFAULT_REPORT_TITLE
static String	generatorLogoPath = null
static final Logger	logger = Logger.getLogger(ReportBranding.class.getName())
static final String	REPORT_FOOTER_PROP = "ReportFooter"
static final String	REPORT_TITLE_PROP = "ReportTitle"

Detailed Description

Manages settings configured report branding and their defaults.

If configured branding is not present on the machine, uses defaults.

Uses module settings property files to store customizations.

Definition at line 37 of file ReportBranding.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.report.ReportBranding.ReportBranding

(

)

Definition at line 61 of file ReportBranding.java.

References org.sleuthkit.autopsy.report.ReportBranding.extractDefaultGeneratorLogo(), org.sleuthkit.autopsy.report.ReportBranding.getAgencyLogoPath(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.getReportsDirectory(), org.sleuthkit.autopsy.report.ReportBranding.getReportTitle(), and org.sleuthkit.autopsy.coreutils.PlatformUtil.getUserConfigDirectory().

Member Function Documentation

void org.sleuthkit.autopsy.report.ReportBranding.extractDefaultGeneratorLogo ( )

private

extract default logo from JAR file to local file.

Definition at line 88 of file ReportBranding.java.

References org.sleuthkit.autopsy.report.ReportBranding.DEFAULT_GENERATOR_LOGO, org.sleuthkit.autopsy.coreutils.PlatformUtil.extractResourceToUserConfigDir(), and org.sleuthkit.autopsy.coreutils.PlatformUtil.getUserConfigDirectory().

Referenced by org.sleuthkit.autopsy.report.ReportBranding.ReportBranding().

String org.sleuthkit.autopsy.report.ReportBranding.getAgencyLogoPath

(

)

Definition at line 113 of file ReportBranding.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting().

Referenced by org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.copyResources(), org.sleuthkit.autopsy.report.ReportBranding.ReportBranding(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeIndex(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeNav(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummaryCaseDetails(), and org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeSummaryHTML().

String org.sleuthkit.autopsy.report.ReportBranding.getGeneratorLogoPath

(

)

Definition at line 98 of file ReportBranding.java.

References org.sleuthkit.autopsy.report.ReportBranding.defaultGeneratorLogoPath, and org.sleuthkit.autopsy.report.ReportBranding.generatorLogoPath.

Referenced by org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.copyResources(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeNav(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().

String org.sleuthkit.autopsy.report.ReportBranding.getReportFooter

(

)

Definition at line 160 of file ReportBranding.java.

References org.sleuthkit.autopsy.report.ReportBranding.DEFAULT_REPORT_FOOTER, org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().

String org.sleuthkit.autopsy.report.ReportBranding.getReportsBrandingDir

(

)

Definition at line 81 of file ReportBranding.java.

References org.sleuthkit.autopsy.report.ReportBranding.reportsBrandingDir.

String org.sleuthkit.autopsy.report.ReportBranding.getReportTitle

(

)

Definition at line 140 of file ReportBranding.java.

References org.sleuthkit.autopsy.report.ReportBranding.DEFAULT_REPORT_TITLE, org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

Referenced by org.sleuthkit.autopsy.report.ReportBranding.ReportBranding(), org.sleuthkit.autopsy.report.modules.kml.KMLReport.setupReportDocument(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeIndex(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().

void org.sleuthkit.autopsy.report.ReportBranding.setAgencyLogoPath

(

String

path

)

Definition at line 133 of file ReportBranding.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

void org.sleuthkit.autopsy.report.ReportBranding.setGeneratorLogoPath

(

String

path

)

Definition at line 108 of file ReportBranding.java.

void org.sleuthkit.autopsy.report.ReportBranding.setReportFooter

(

String

footer

)

Definition at line 175 of file ReportBranding.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

void org.sleuthkit.autopsy.report.ReportBranding.setReportTitle

(

String

title

)

Definition at line 155 of file ReportBranding.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

Member Data Documentation

final String org.sleuthkit.autopsy.report.ReportBranding.AGENCY_LOGO_PATH_PROP = "AgencyLogoPath"

static

Definition at line 40 of file ReportBranding.java.

final String org.sleuthkit.autopsy.report.ReportBranding.DEFAULT_GENERATOR_LOGO = "/org/sleuthkit/autopsy/report/images/default_generator_logo.png"

staticprivate

Definition at line 44 of file ReportBranding.java.

Referenced by org.sleuthkit.autopsy.report.ReportBranding.extractDefaultGeneratorLogo().

final String org.sleuthkit.autopsy.report.ReportBranding.DEFAULT_REPORT_FOOTER

staticprivate

Initial value:

= NbBundle
            .getMessage(ReportBranding.class, "ReportBranding.defaultReportFooter.text")

Definition at line 47 of file ReportBranding.java.

Referenced by org.sleuthkit.autopsy.report.ReportBranding.getReportFooter().

final String org.sleuthkit.autopsy.report.ReportBranding.DEFAULT_REPORT_TITLE

staticprivate

Initial value:

= NbBundle
            .getMessage(ReportBranding.class, "ReportBranding.defaultReportTitle.text")

Definition at line 45 of file ReportBranding.java.

Referenced by org.sleuthkit.autopsy.report.ReportBranding.getReportTitle().

String org.sleuthkit.autopsy.report.ReportBranding.defaultGeneratorLogoPath

private

Definition at line 59 of file ReportBranding.java.

Referenced by org.sleuthkit.autopsy.report.ReportBranding.getGeneratorLogoPath().

String org.sleuthkit.autopsy.report.ReportBranding.generatorLogoPath = null

staticprivate

Definition at line 57 of file ReportBranding.java.

Referenced by org.sleuthkit.autopsy.report.ReportBranding.getGeneratorLogoPath().

final Logger org.sleuthkit.autopsy.report.ReportBranding.logger = Logger.getLogger(ReportBranding.class.getName())

staticprivate

Definition at line 51 of file ReportBranding.java.

final String org.sleuthkit.autopsy.report.ReportBranding.MODULE_NAME = ReportBranding.class.getSimpleName()

static

Definition at line 50 of file ReportBranding.java.

final String org.sleuthkit.autopsy.report.ReportBranding.REPORT_FOOTER_PROP = "ReportFooter"

staticprivate

Definition at line 42 of file ReportBranding.java.

final String org.sleuthkit.autopsy.report.ReportBranding.REPORT_TITLE_PROP = "ReportTitle"

staticprivate

Definition at line 41 of file ReportBranding.java.

String org.sleuthkit.autopsy.report.ReportBranding.reportsBrandingDir

private

Definition at line 49 of file ReportBranding.java.

Referenced by org.sleuthkit.autopsy.report.ReportBranding.getReportsBrandingDir().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/report/ReportBranding.java