Classes
class	TextConverter

Static Public Member Functions
static void	addChangeListener (PreferenceChangeListener listener)

static boolean	displayTimesInLocalTime ()

static String	getAppName ()

static CaseDbConnectionInfo	getDatabaseConnectionInfo () throws UserPreferencesException

static String	getIndexingServerHost ()

static String	getIndexingServerPort ()

static boolean	getIsMultiUserModeEnabled ()

static boolean	getIsTimeOutEnabled ()

static MessageServiceConnectionInfo	getMessageServiceConnectionInfo () throws UserPreferencesException

static int	getProcessTimeOutHrs ()

static boolean	hideKnownFilesInDataSourcesTree ()

static boolean	hideKnownFilesInViewsTree ()

static boolean	hideSlackFilesInDataSourcesTree ()

static boolean	hideSlackFilesInViewsTree ()

static boolean	keepPreferredContentViewer ()

static int	numberOfFileIngestThreads ()

static void	reloadFromStorage () throws BackingStoreException

static void	removeChangeListener (PreferenceChangeListener listener)

static void	saveToStorage () throws BackingStoreException

static void	setAppName (String name)

static void	setDatabaseConnectionInfo (CaseDbConnectionInfo connectionInfo) throws UserPreferencesException

static void	setDisplayTimesInLocalTime (boolean value)

static void	setHideKnownFilesInDataSourcesTree (boolean value)

static void	setHideKnownFilesInViewsTree (boolean value)

static void	setHideSlackFilesInDataSourcesTree (boolean value)

static void	setHideSlackFilesInViewsTree (boolean value)

static void	setIndexingServerHost (String hostName)

static void	setIndexingServerPort (int port)

static void	setIsMultiUserModeEnabled (boolean enabled)

static void	setIsTimeOutEnabled (boolean enabled)

static void	setKeepPreferredContentViewer (boolean value)

static void	setMessageServiceConnectionInfo (MessageServiceConnectionInfo info) throws UserPreferencesException

static void	setNumberOfFileIngestThreads (int value)

static void	setProcessTimeOutHrs (int value)

Static Public Attributes
static final String	DISPLAY_TIMES_IN_LOCAL_TIME = "DisplayTimesInLocalTime"

static final String	EXTERNAL_DATABASE_HOSTNAME_OR_IP = "ExternalDatabaseHostnameOrIp"

static final String	EXTERNAL_DATABASE_NAME = "ExternalDatabaseName"

static final String	EXTERNAL_DATABASE_PASSWORD = "ExternalDatabasePassword"

static final String	EXTERNAL_DATABASE_PORTNUMBER = "ExternalDatabasePortNumber"

static final String	EXTERNAL_DATABASE_TYPE = "ExternalDatabaseType"

static final String	EXTERNAL_DATABASE_USER = "ExternalDatabaseUsername"

static final String	HIDE_KNOWN_FILES_IN_DATA_SRCS_TREE = "HideKnownFilesInDataSourcesTree"

static final String	HIDE_KNOWN_FILES_IN_VIEWS_TREE = "HideKnownFilesInViewsTree"

static final String	HIDE_SLACK_FILES_IN_DATA_SRCS_TREE = "HideSlackFilesInDataSourcesTree"

static final String	HIDE_SLACK_FILES_IN_VIEWS_TREE = "HideSlackFilesInViewsTree"

static final String	INDEXING_SERVER_HOST = "IndexingServerHost"

static final String	INDEXING_SERVER_PORT = "IndexingServerPort"

static final String	IS_MULTI_USER_MODE_ENABLED = "IsMultiUserModeEnabled"

static final String	KEEP_PREFERRED_VIEWER = "KeepPreferredViewer"

static final String	NUMBER_OF_FILE_INGEST_THREADS = "NumberOfFileIngestThreads"

static final String	PROCESS_TIME_OUT_ENABLED = "ProcessTimeOutEnabled"

static final String	PROCESS_TIME_OUT_HOURS = "ProcessTimeOutHours"

Private Member Functions
	UserPreferences ()

Static Private Attributes
static final String	APP_NAME = "AppName"

static final int	DEFAULT_PORT_INT = 61616

static final String	DEFAULT_PORT_STRING = "61616"

static final int	DEFAULT_PROCESS_TIMEOUT_HR = 60

static final boolean	IS_WINDOWS_OS = PlatformUtil.isWindowsOS()

static final String	MESSAGE_SERVICE_HOST = "MessageServiceHost"

static final String	MESSAGE_SERVICE_PASSWORD = "MessageServicePassword"

static final String	MESSAGE_SERVICE_PORT = "MessageServicePort"

static final String	MESSAGE_SERVICE_USER = "MessageServiceUser"

static final Preferences	preferences = NbPreferences.forModule(UserPreferences.class)

Detailed Description

Provides convenient access to a Preferences node for user preferences with default values.

Definition at line 41 of file UserPreferences.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.core.UserPreferences.UserPreferences ( )

private

Definition at line 73 of file UserPreferences.java.

Member Function Documentation

static void org.sleuthkit.autopsy.core.UserPreferences.addChangeListener ( PreferenceChangeListener listener )

static

Definition at line 97 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.subscribeToChangeEvents().

static boolean org.sleuthkit.autopsy.core.UserPreferences.displayTimesInLocalTime ( )

static

Definition at line 145 of file UserPreferences.java.

static String org.sleuthkit.autopsy.core.UserPreferences.getAppName ( )

static

Get the display name for this program

Returns: Name of this program

Definition at line 310 of file UserPreferences.java.

static CaseDbConnectionInfo org.sleuthkit.autopsy.core.UserPreferences.getDatabaseConnectionInfo ( ) throws UserPreferencesException

static

Reads persisted case database connection info.

Returns: An object encapsulating the database connection info.

Exceptions

org.sleuthkit.autopsy.core.UserPreferencesException

Definition at line 166 of file UserPreferences.java.

References org::sleuthkit::datamodel::TskData::DbType.SQLITE.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkDatabaseConnectionStatus(), org.sleuthkit.autopsy.casemodule.Case.create(), org.sleuthkit.autopsy.casemodule.Case.deleteCase(), org.sleuthkit.autopsy.casemodule.SingleUserCaseConverter.ImportCaseData.ImportCaseData(), and org.sleuthkit.autopsy.casemodule.Case.openCaseDatabase().

static String org.sleuthkit.autopsy.core.UserPreferences.getIndexingServerHost ( )

static

Definition at line 207 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkKeywordSearchServerConnectionStatus(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.CoordinationService(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.isZooKeeperAccessible(), org.sleuthkit.autopsy.keywordsearch.Server.openCore(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

static String org.sleuthkit.autopsy.core.UserPreferences.getIndexingServerPort ( )

static

Definition at line 215 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkKeywordSearchServerConnectionStatus(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.CoordinationService(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.isZooKeeperAccessible(), org.sleuthkit.autopsy.keywordsearch.Server.openCore(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

static boolean org.sleuthkit.autopsy.core.UserPreferences.getIsMultiUserModeEnabled ( )

static

Definition at line 200 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkAllServices(), and org.sleuthkit.autopsy.casemodule.Case.openCaseDatabase().

static boolean org.sleuthkit.autopsy.core.UserPreferences.getIsTimeOutEnabled ( )

static

Reads persisted setting of whether process time out functionality is enabled.

Returns: boolean True if process time out is functionality enabled, false otherwise.

Definition at line 290 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.coreutils.ExecUtil.TimedProcessTerminator.TimedProcessTerminator().

static MessageServiceConnectionInfo org.sleuthkit.autopsy.core.UserPreferences.getMessageServiceConnectionInfo ( ) throws UserPreferencesException

static

Reads persisted message service connection info.

Returns: An object encapsulating the message service info.

Exceptions

org.sleuthkit.autopsy.core.UserPreferencesException

Definition at line 242 of file UserPreferences.java.

References org.sleuthkit.autopsy.core.UserPreferences.DEFAULT_PORT_INT.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkMessagingServerConnectionStatus(), and org.sleuthkit.autopsy.events.AutopsyEventPublisher.openRemoteEventChannel().

static int org.sleuthkit.autopsy.core.UserPreferences.getProcessTimeOutHrs ( )

static

Reads persisted process time out value.

Returns: int Process time out value (hours).

Definition at line 263 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.coreutils.ExecUtil.TimedProcessTerminator.TimedProcessTerminator().

static boolean org.sleuthkit.autopsy.core.UserPreferences.hideKnownFilesInDataSourcesTree ( )

static

Definition at line 113 of file UserPreferences.java.

static boolean org.sleuthkit.autopsy.core.UserPreferences.hideKnownFilesInViewsTree ( )

static

Definition at line 121 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.datamodel.FileTypesByExtension.FileExtensionNode.FileExtensionNodeChildren.createQuery(), and org.sleuthkit.autopsy.datamodel.FileTypesByMimeType.MediaSubTypeNodeChildren.createQuery().

static boolean org.sleuthkit.autopsy.core.UserPreferences.hideSlackFilesInDataSourcesTree ( )

static

Definition at line 129 of file UserPreferences.java.

static boolean org.sleuthkit.autopsy.core.UserPreferences.hideSlackFilesInViewsTree ( )

static

Definition at line 137 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.datamodel.FileTypesByMimeType.MediaSubTypeNodeChildren.createQuery(), and org.sleuthkit.autopsy.datamodel.FileTypesByMimeType.populateHashMap().

static boolean org.sleuthkit.autopsy.core.UserPreferences.keepPreferredContentViewer ( )

static

Definition at line 105 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.DataContentPanel.setupTabs().

static int org.sleuthkit.autopsy.core.UserPreferences.numberOfFileIngestThreads ( )

static

Definition at line 153 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestManager.IngestManager().

static void org.sleuthkit.autopsy.core.UserPreferences.reloadFromStorage ( ) throws BackingStoreException

static

Reload all preferences from disk. This is only needed if the preferences file is being directly modified on disk while Autopsy is running.

Exceptions

BackingStoreException

Definition at line 82 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.removeChangeListener ( PreferenceChangeListener listener )

static

Definition at line 101 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.saveToStorage ( ) throws BackingStoreException

static

Saves the current preferences to storage. This is only needed if the preferences files are going to be copied to another location while Autopsy is running.

Exceptions

BackingStoreException

Definition at line 93 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setAppName ( String name )

static

Set the display name for this program

Parameters

name	Display name

Definition at line 319 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setDatabaseConnectionInfo ( CaseDbConnectionInfo connectionInfo ) throws UserPreferencesException

static

Persists case database connection info.

Parameters

connectionInfo An object encapsulating the database connection info.

Exceptions

org.sleuthkit.autopsy.core.UserPreferencesException

Definition at line 188 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setDisplayTimesInLocalTime ( boolean value )

static

Definition at line 149 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setHideKnownFilesInDataSourcesTree ( boolean value )

static

Definition at line 117 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setHideKnownFilesInViewsTree ( boolean value )

static

Definition at line 125 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setHideSlackFilesInDataSourcesTree ( boolean value )

static

Definition at line 133 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setHideSlackFilesInViewsTree ( boolean value )

static

Definition at line 141 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setIndexingServerHost ( String hostName )

static

Definition at line 211 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setIndexingServerPort ( int port )

static

Definition at line 219 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setIsMultiUserModeEnabled ( boolean enabled )

static

Definition at line 196 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setIsTimeOutEnabled ( boolean enabled )

static

Stores persisted setting of whether process time out functionality is enabled.

Parameters

enabled Persisted setting of whether process time out functionality is enabled.

Definition at line 302 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setKeepPreferredContentViewer ( boolean value )

static

Definition at line 109 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setMessageServiceConnectionInfo ( MessageServiceConnectionInfo info ) throws UserPreferencesException

static

Persists message service connection info.

Parameters

info	An object encapsulating the message service info.

Exceptions

org.sleuthkit.autopsy.core.UserPreferencesException

Definition at line 229 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setNumberOfFileIngestThreads ( int value )

static

Definition at line 157 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestManager.IngestManager().

static void org.sleuthkit.autopsy.core.UserPreferences.setProcessTimeOutHrs ( int value )

static

Stores persisted process time out value.

Parameters

value Persisted process time out value (hours).

Definition at line 276 of file UserPreferences.java.

Member Data Documentation

final String org.sleuthkit.autopsy.core.UserPreferences.APP_NAME = "AppName"

staticprivate

Definition at line 70 of file UserPreferences.java.

final int org.sleuthkit.autopsy.core.UserPreferences.DEFAULT_PORT_INT = 61616

staticprivate

Definition at line 69 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.core.UserPreferences.getMessageServiceConnectionInfo().

final String org.sleuthkit.autopsy.core.UserPreferences.DEFAULT_PORT_STRING = "61616"

staticprivate

Definition at line 68 of file UserPreferences.java.

final int org.sleuthkit.autopsy.core.UserPreferences.DEFAULT_PROCESS_TIMEOUT_HR = 60

staticprivate

Definition at line 67 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.DISPLAY_TIMES_IN_LOCAL_TIME = "DisplayTimesInLocalTime"

static

Definition at line 50 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.EXTERNAL_DATABASE_HOSTNAME_OR_IP = "ExternalDatabaseHostnameOrIp"

static

Definition at line 53 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.EXTERNAL_DATABASE_NAME = "ExternalDatabaseName"

static

Definition at line 55 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.EXTERNAL_DATABASE_PASSWORD = "ExternalDatabasePassword"

static

Definition at line 57 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.EXTERNAL_DATABASE_PORTNUMBER = "ExternalDatabasePortNumber"

static

Definition at line 54 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.EXTERNAL_DATABASE_TYPE = "ExternalDatabaseType"

static

Definition at line 58 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.EXTERNAL_DATABASE_USER = "ExternalDatabaseUsername"

static

Definition at line 56 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.HIDE_KNOWN_FILES_IN_DATA_SRCS_TREE = "HideKnownFilesInDataSourcesTree"

static

Definition at line 46 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.subscribeToChangeEvents().

final String org.sleuthkit.autopsy.core.UserPreferences.HIDE_KNOWN_FILES_IN_VIEWS_TREE = "HideKnownFilesInViewsTree"

static

Definition at line 47 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.subscribeToChangeEvents().

final String org.sleuthkit.autopsy.core.UserPreferences.HIDE_SLACK_FILES_IN_DATA_SRCS_TREE = "HideSlackFilesInDataSourcesTree"

static

Definition at line 48 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.subscribeToChangeEvents().

final String org.sleuthkit.autopsy.core.UserPreferences.HIDE_SLACK_FILES_IN_VIEWS_TREE = "HideSlackFilesInViewsTree"

static

Definition at line 49 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.subscribeToChangeEvents().

final String org.sleuthkit.autopsy.core.UserPreferences.INDEXING_SERVER_HOST = "IndexingServerHost"

static

Definition at line 59 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.INDEXING_SERVER_PORT = "IndexingServerPort"

static

Definition at line 60 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.IS_MULTI_USER_MODE_ENABLED = "IsMultiUserModeEnabled"

static

Definition at line 52 of file UserPreferences.java.

final boolean org.sleuthkit.autopsy.core.UserPreferences.IS_WINDOWS_OS = PlatformUtil.isWindowsOS()

staticprivate

Definition at line 43 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.KEEP_PREFERRED_VIEWER = "KeepPreferredViewer"

static

Definition at line 45 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.MESSAGE_SERVICE_HOST = "MessageServiceHost"

staticprivate

Definition at line 63 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.MESSAGE_SERVICE_PASSWORD = "MessageServicePassword"

staticprivate

Definition at line 61 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.MESSAGE_SERVICE_PORT = "MessageServicePort"

staticprivate

Definition at line 64 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.MESSAGE_SERVICE_USER = "MessageServiceUser"

staticprivate

Definition at line 62 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.NUMBER_OF_FILE_INGEST_THREADS = "NumberOfFileIngestThreads"

static

Definition at line 51 of file UserPreferences.java.

final Preferences org.sleuthkit.autopsy.core.UserPreferences.preferences = NbPreferences.forModule(UserPreferences.class)

staticprivate

Definition at line 44 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.PROCESS_TIME_OUT_ENABLED = "ProcessTimeOutEnabled"

static

Definition at line 65 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.PROCESS_TIME_OUT_HOURS = "ProcessTimeOutHours"

static

Definition at line 66 of file UserPreferences.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/core/UserPreferences.java

Classes

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation