Autopsy  4.5.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Static Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Attributes | List of all members
org.sleuthkit.autopsy.core.UserPreferences Class Reference

Classes

enum  SelectedMode
 

Static Public Member Functions

static void addChangeListener (PreferenceChangeListener listener)
 
static boolean displayTimesInLocalTime ()
 
static String getAppName ()
 
static CaseDbConnectionInfo getDatabaseConnectionInfo () throws UserPreferencesException
 
static int getDefaultLogFileCount ()
 
static String getIndexingServerHost ()
 
static String getIndexingServerPort ()
 
static boolean getIsMultiUserModeEnabled ()
 
static boolean getIsTimeOutEnabled ()
 
static int getLogFileCount ()
 
static MessageServiceConnectionInfo getMessageServiceConnectionInfo () throws UserPreferencesException
 
static SelectedMode getMode ()
 
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 setLogFileCount (int count)
 
static void setMessageServiceConnectionInfo (MessageServiceConnectionInfo info) throws UserPreferencesException
 
static void setMode (SelectedMode mode)
 
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"
 
static final String SETTINGS_PROPERTIES = "AutoIngest"
 

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 int LOG_FILE_NUM_INT = 10
 
static final String MAX_NUM_OF_LOG_FILE = "MaximumNumberOfLogFiles"
 
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 String MODE = "AutopsyMode"
 
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 38 of file UserPreferences.java.

Constructor & Destructor Documentation

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

Definition at line 74 of file UserPreferences.java.

Member Function Documentation

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

Definition at line 174 of file UserPreferences.java.

static String org.sleuthkit.autopsy.core.UserPreferences.getAppName ( )
static
static CaseDbConnectionInfo org.sleuthkit.autopsy.core.UserPreferences.getDatabaseConnectionInfo ( ) throws UserPreferencesException
static
static int org.sleuthkit.autopsy.core.UserPreferences.getDefaultLogFileCount ( )
static

get the default number of log files to save

Returns
LOG_FILE_COUNT

Definition at line 386 of file UserPreferences.java.

References org.sleuthkit.autopsy.core.UserPreferences.LOG_FILE_NUM_INT.

static String org.sleuthkit.autopsy.core.UserPreferences.getIndexingServerHost ( )
static
static String org.sleuthkit.autopsy.core.UserPreferences.getIndexingServerPort ( )
static
static boolean org.sleuthkit.autopsy.core.UserPreferences.getIsMultiUserModeEnabled ( )
static
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 340 of file UserPreferences.java.

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

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

get the maximum number of log files to save

Returns
Number of log files

Definition at line 378 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.coreutils.Logger.createFileHandlerWithTraces().

static MessageServiceConnectionInfo org.sleuthkit.autopsy.core.UserPreferences.getMessageServiceConnectionInfo ( ) throws UserPreferencesException
static
static SelectedMode org.sleuthkit.autopsy.core.UserPreferences.getMode ( )
static
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 313 of file UserPreferences.java.

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

static boolean org.sleuthkit.autopsy.core.UserPreferences.hideKnownFilesInDataSourcesTree ( )
static
static boolean org.sleuthkit.autopsy.core.UserPreferences.hideKnownFilesInViewsTree ( )
static
static boolean org.sleuthkit.autopsy.core.UserPreferences.hideSlackFilesInDataSourcesTree ( )
static
static boolean org.sleuthkit.autopsy.core.UserPreferences.hideSlackFilesInViewsTree ( )
static

Definition at line 166 of file UserPreferences.java.

static boolean org.sleuthkit.autopsy.core.UserPreferences.keepPreferredContentViewer ( )
static
static int org.sleuthkit.autopsy.core.UserPreferences.numberOfFileIngestThreads ( )
static
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 111 of file UserPreferences.java.

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

Definition at line 130 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 122 of file UserPreferences.java.

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

Set the display name for this program

Parameters
nameDisplay name

Definition at line 370 of file UserPreferences.java.

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

Persists case database connection info.

Parameters
connectionInfoAn object encapsulating the database connection info.
Exceptions
org.sleuthkit.autopsy.core.UserPreferencesException

Definition at line 224 of file UserPreferences.java.

References org.sleuthkit.autopsy.coreutils.TextConverter.convertTextToHexText().

Referenced by org.sleuthkit.autopsy.testing.AutopsyTestCases.setMultiUserPerferences().

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

Definition at line 178 of file UserPreferences.java.

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

Definition at line 146 of file UserPreferences.java.

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

Definition at line 154 of file UserPreferences.java.

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

Definition at line 162 of file UserPreferences.java.

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

Definition at line 170 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setIndexingServerHost ( String  hostName)
static
static void org.sleuthkit.autopsy.core.UserPreferences.setIndexingServerPort ( int  port)
static
static void org.sleuthkit.autopsy.core.UserPreferences.setIsMultiUserModeEnabled ( boolean  enabled)
static
static void org.sleuthkit.autopsy.core.UserPreferences.setIsTimeOutEnabled ( boolean  enabled)
static

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

Parameters
enabledPersisted setting of whether process time out functionality is enabled.

Definition at line 352 of file UserPreferences.java.

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

Definition at line 138 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setLogFileCount ( int  count)
static

Set the maximum number of log files to save

Parameters
countnumber of log files

Definition at line 393 of file UserPreferences.java.

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

Persists message service connection info.

Parameters
infoAn object encapsulating the message service info.
Exceptions
org.sleuthkit.autopsy.core.UserPreferencesException

Definition at line 270 of file UserPreferences.java.

References org.sleuthkit.autopsy.coreutils.TextConverter.convertTextToHexText().

Referenced by org.sleuthkit.autopsy.testing.AutopsyTestCases.setMultiUserPerferences().

static void org.sleuthkit.autopsy.core.UserPreferences.setMode ( SelectedMode  mode)
static

Set mode to persistent storage.

Parameters
modeSelected mode.

Definition at line 101 of file UserPreferences.java.

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

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

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

Definition at line 186 of file UserPreferences.java.

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

Stores persisted process time out value.

Parameters
valuePersisted process time out value (hours).

Definition at line 326 of file UserPreferences.java.

Member Data Documentation

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

Definition at line 67 of file UserPreferences.java.

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

Definition at line 65 of file UserPreferences.java.

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

Definition at line 64 of file UserPreferences.java.

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

Definition at line 50 of file UserPreferences.java.

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

Definition at line 52 of file UserPreferences.java.

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

Definition at line 54 of file UserPreferences.java.

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

Definition at line 51 of file UserPreferences.java.

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

Definition at line 55 of file UserPreferences.java.

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

Definition at line 53 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.HIDE_KNOWN_FILES_IN_DATA_SRCS_TREE = "HideKnownFilesInDataSourcesTree"
static
final String org.sleuthkit.autopsy.core.UserPreferences.HIDE_KNOWN_FILES_IN_VIEWS_TREE = "HideKnownFilesInViewsTree"
static
final String org.sleuthkit.autopsy.core.UserPreferences.HIDE_SLACK_FILES_IN_DATA_SRCS_TREE = "HideSlackFilesInDataSourcesTree"
static
final String org.sleuthkit.autopsy.core.UserPreferences.HIDE_SLACK_FILES_IN_VIEWS_TREE = "HideSlackFilesInViewsTree"
static
final String org.sleuthkit.autopsy.core.UserPreferences.INDEXING_SERVER_HOST = "IndexingServerHost"
static

Definition at line 56 of file UserPreferences.java.

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

Definition at line 57 of file UserPreferences.java.

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

Definition at line 49 of file UserPreferences.java.

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

Definition at line 40 of file UserPreferences.java.

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

Definition at line 42 of file UserPreferences.java.

final int org.sleuthkit.autopsy.core.UserPreferences.LOG_FILE_NUM_INT = 10
staticprivate
final String org.sleuthkit.autopsy.core.UserPreferences.MAX_NUM_OF_LOG_FILE = "MaximumNumberOfLogFiles"
staticprivate

Definition at line 70 of file UserPreferences.java.

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

Definition at line 60 of file UserPreferences.java.

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

Definition at line 58 of file UserPreferences.java.

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

Definition at line 61 of file UserPreferences.java.

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

Definition at line 59 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.MODE = "AutopsyMode"
staticprivate

Definition at line 69 of file UserPreferences.java.

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

Definition at line 48 of file UserPreferences.java.

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

Definition at line 41 of file UserPreferences.java.

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

Definition at line 62 of file UserPreferences.java.

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

Definition at line 63 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.SETTINGS_PROPERTIES = "AutoIngest"
static

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

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