Autopsy  4.21.0
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 Class Reference


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

Constructor & Destructor Documentation ( )

Member Function Documentation

void ( )
String ( )

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.

Full path to the logo file.

Definition at line 124 of file

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

Referenced by,,,,, and

String ( )
String ( )
String ( )
String ( )
void ( 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.

fullPathFull path to the logo file.

Definition at line 166 of file

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

void ( String  path)

Definition at line 111 of file

void ( String  footer)
void ( String  title)

Member Data Documentation

final String = "AgencyLogoPath"

Definition at line 42 of file

final String = "/org/sleuthkit/autopsy/report/images/default_generator_logo.png"
final String
Initial value:
= NbBundle
.getMessage(ReportBranding.class, "ReportBranding.defaultReportFooter.text")

Definition at line 49 of file

Referenced by

final String
Initial value:
= NbBundle
.getMessage(ReportBranding.class, "ReportBranding.defaultReportTitle.text")

Definition at line 47 of file

Referenced by

String = null
final Logger = Logger.getLogger(ReportBranding.class.getName())

Definition at line 54 of file

final String = ReportBranding.class.getSimpleName()

Definition at line 53 of file

final String = "ReportFooter"

Definition at line 44 of file

final String = "ReportTitle"

Definition at line 43 of file

final String
final Path = Paths.get(PlatformUtil.getUserDirectory().getAbsolutePath())

Definition at line 52 of file

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

Copyright © 2012-2022 Basis Technology. Generated on: Tue Feb 6 2024
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.