org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer Class Reference

Inherits ModuleInstall.

Public Member Functions
void	restored ()
void	uninstalled ()

Static Public Member Functions
static synchronized Installer	getDefault ()

Private Member Functions
	Installer ()
void	doMessageBoxIfRunningInGUI (CentralRepoException ex)
String	getSettingsFilePath (String moduleName)
void	setupDefaultCentralRepository ()
void	upgradeSettingsPath ()

Static Private Attributes
static Installer	instance
static final String	LEGACY_DEFAULT_DB_PARENT_PATH = Paths.get(PlatformUtil.getUserDirectory().getAbsolutePath(), LEGACY_DEFAULT_FOLDER).toAbsolutePath().toString()
static final String	LEGACY_DEFAULT_FOLDER = "central_repository"
static final String	LEGACY_MODULE_SETTINGS_KEY = "CentralRepository"
static final Logger	logger = Logger.getLogger(Installer.class.getName())
static final long	serialVersionUID = 1L

Detailed Description

Sets up a default, single-user SQLite central repository if no central repository is configured, and updates the central repository schema as required.

Definition at line 47 of file Installer.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.Installer ( )

private

Constructs the singleton "package installer" used by the registered Installer for the Autopsy-Core module located in the org.sleuthkit.autopsy.core package.

Definition at line 77 of file Installer.java.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.getDefault().

Member Function Documentation

void org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.doMessageBoxIfRunningInGUI ( CentralRepoException  ex )

private

Display a central repository exception in a message box if running with a GUI.

Parameters

ex	The exception.

Definition at line 209 of file Installer.java.

References org.sleuthkit.autopsy.exceptions.AutopsyException.getUserMessage(), and org.sleuthkit.autopsy.core.RuntimeProperties.runningWithGUI.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.setupDefaultCentralRepository().

static synchronized Installer org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.getDefault ( )

static

Gets the singleton "package installer" used by the registered Installer for the Autopsy-Core module located in the org.sleuthkit.autopsy.core package.

Returns

The "package installer" singleton for the org.sleuthkit.autopsy.centralrepository.eventlisteners package.

Definition at line 65 of file Installer.java.

References org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.Installer(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.instance.

Referenced by org.sleuthkit.autopsy.core.Installer.Installer().

String org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.getSettingsFilePath ( String  moduleName )

private

Path to module settings path.

Parameters

moduleName

The full name of the module provided to ModuleSettings.

Returns

The path on disk for that object. NOTE: This must be in sync with ModuleSettings.

Definition at line 106 of file Installer.java.

References org.sleuthkit.autopsy.coreutils.PlatformUtil.getUserConfigDirectory().

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.upgradeSettingsPath().

void org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.restored

(

)

Definition at line 90 of file Installer.java.

References org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.setupDefaultCentralRepository(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.upgradeSettingsPath().

void org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.setupDefaultCentralRepository ( )

private

Checks if the central repository has been set up and configured. If not, does the set up unconditionally. If the application is running with a GUI, a notification will be displayed to the user if the mode is RELEASE (in other words, developers are exempt from seeing the notification).

Definition at line 160 of file Installer.java.

References org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.doMessageBoxIfRunningInGUI(), org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSettings(), org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getInstance(), org.sleuthkit.autopsy.core.UserPreferences.getIsMultiUserModeEnabled(), org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getModuleSettingsKey(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbChoice.POSTGRESQL_MULTIUSER, org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.setupDefaultSqliteDb(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.setupPostgresDb().

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.restored().

void org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.uninstalled

(

)

Definition at line 225 of file Installer.java.

void org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.upgradeSettingsPath ( )

private

Copies settings to new path location.

Definition at line 113 of file Installer.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSettings(), org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDatabaseNameKey(), org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDatabasePathKey(), org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDefaultDbPath(), org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getInstance(), org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getModuleSettingsKey(), org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.getSettingsFilePath(), org.sleuthkit.autopsy.coreutils.PlatformUtil.getUserDirectory(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSettings().

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.restored().

Member Data Documentation

Installer org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.instance

staticprivate

Definition at line 55 of file Installer.java.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.getDefault().

final String org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.LEGACY_DEFAULT_DB_PARENT_PATH = Paths.get(PlatformUtil.getUserDirectory().getAbsolutePath(), LEGACY_DEFAULT_FOLDER).toAbsolutePath().toString()

staticprivate

Definition at line 50 of file Installer.java.

final String org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.LEGACY_DEFAULT_FOLDER = "central_repository"

staticprivate

Definition at line 49 of file Installer.java.

final String org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.LEGACY_MODULE_SETTINGS_KEY = "CentralRepository"

staticprivate

Definition at line 51 of file Installer.java.

final Logger org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.logger = Logger.getLogger(Installer.class.getName())

staticprivate

Definition at line 53 of file Installer.java.

final long org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.serialVersionUID = 1L

staticprivate

Definition at line 54 of file Installer.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/centralrepository/eventlisteners/Installer.java