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 fullPath)
void	setGeneratorLogoPath (String path)
void	setReportFooter (String footer)
void	setReportTitle (String title)

Private Member Functions
void	extractDefaultGeneratorLogo ()

Private Attributes
String	defaultGeneratorLogoPath
final String	reportsBrandingDir
final Path	userConfigDir = Paths.get(PlatformUtil.getUserDirectory().getAbsolutePath())

Static Private Attributes
static final String	AGENCY_LOGO_PATH_PROP = "AgencyLogoPath"
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	MODULE_NAME = ReportBranding.class.getSimpleName()
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 39 of file ReportBranding.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.report.ReportBranding.ReportBranding

(

)

Definition at line 64 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 91 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

(

)

Read logo path from preferences file. Reverses the path relativization performed in setAgencyLogoPath(). If the stored path starts with either “/” or drive letter, it is a full path, and is returned to the caller. Otherwise, append current user directory to the saved relative path. See JIRA-7348.

Returns

Full path to the logo file.

Definition at line 124 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 101 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 198 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 84 of file ReportBranding.java.

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

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

(

)

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

fullPath

)

Save logo path. If the path is inside user directory (e.g. "C:\Users\USER_NAME\AppData\Roaming\autopsy"), trim that off and save it as a relative path (i.e it will not start with a “/” or drive letter). Otherwise, full path is saved. See JIRA-7348.

Parameters

fullPath

Full path to the logo file.

Definition at line 166 of file ReportBranding.java.

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

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

(

String

path

)

Definition at line 111 of file ReportBranding.java.

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

(

String

footer

)

Definition at line 212 of file ReportBranding.java.

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

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

(

String

title

)

Definition at line 193 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"

staticprivate

Definition at line 42 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 46 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 49 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 47 of file ReportBranding.java.

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

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

private

Definition at line 62 of file ReportBranding.java.

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

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

staticprivate

Definition at line 60 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 54 of file ReportBranding.java.

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

staticprivate

Definition at line 53 of file ReportBranding.java.

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

staticprivate

Definition at line 44 of file ReportBranding.java.

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

staticprivate

Definition at line 43 of file ReportBranding.java.

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

private

Definition at line 51 of file ReportBranding.java.

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

final Path org.sleuthkit.autopsy.report.ReportBranding.userConfigDir = Paths.get(PlatformUtil.getUserDirectory().getAbsolutePath())

private

Definition at line 52 of file ReportBranding.java.

---

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

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