Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Static Public Member Functions | Static Public Attributes | Private Member Functions | Static 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 boolean displayTranslatedFileNames ()
 
static String getAppName ()
 
static String getAppTempDirectory ()
 
static CaseDbConnectionInfo getDatabaseConnectionInfo () throws UserPreferencesException
 
static int getDefaultLogFileCount ()
 
static String getExternalHexEditorPath ()
 
static String getGeolocationMBTilesFilePath ()
 
static String getGeolocationOsmServerAddress ()
 
static String getGeolocationOsmZipPath ()
 
static int getGeolocationtTileOption ()
 
static String getHealthMonitorReportPath ()
 
static boolean getHideSCOColumns ()
 
static String getIndexingServerHost ()
 
static String getIndexingServerPort ()
 
static boolean getIsMultiUserModeEnabled ()
 
static boolean getIsTimeOutEnabled ()
 
static int getLogFileCount ()
 
static int getMaxSolrVMSize ()
 
static MessageServiceConnectionInfo getMessageServiceConnectionInfo () throws UserPreferencesException
 
static SelectedMode getMode ()
 
static int getProcessTimeOutHrs ()
 
static int getResultsTablePageSize ()
 
static String getSolr4ServerHost ()
 
static String getSolr4ServerPort ()
 
static String getTextTranslatorName ()
 
static String getTimeZoneForDisplays ()
 
static boolean getUseOcrInTranslation ()
 
static String getZkServerHost ()
 
static String getZkServerPort ()
 
static boolean groupItemsInTreeByDatasource ()
 
static boolean hideKnownFilesInDataSourcesTree ()
 
static boolean hideKnownFilesInViewsTree ()
 
static boolean hideSlackFilesInDataSourcesTree ()
 
static boolean hideSlackFilesInViewsTree ()
 
static boolean isMultiUserSupported ()
 
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 setDisplayTranslatedFileNames (boolean value)
 
static void setExternalHexEditorPath (String executablePath)
 
static void setGeolocationMBTilesFilePath (String absolutePath)
 
static void setGeolocationOsmServerAddress (String address)
 
static void setGeolocationOsmZipPath (String absolutePath)
 
static void setGeolocationTileOption (int option)
 
static void setGroupItemsInTreeByDatasource (boolean value)
 
static void setHealthMonitorReportPath (String reportPath)
 
static void setHideKnownFilesInDataSourcesTree (boolean value)
 
static void setHideKnownFilesInViewsTree (boolean value)
 
static void setHideSCOColumns (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 setMaxSolrVMSize (int maxSize)
 
static void setMessageServiceConnectionInfo (MessageServiceConnectionInfo info) throws UserPreferencesException
 
static void setMode (SelectedMode mode)
 
static void setNumberOfFileIngestThreads (int value)
 
static void setProcessTimeOutHrs (int value)
 
static void setResultsTablePageSize (int pageSize)
 
static void setShowOnlyCurrentUserTags (boolean value)
 
static void setSolr4ServerHost (String hostName)
 
static void setSolr4ServerPort (String port)
 
static void setTextTranslatorName (String textTranslatorName)
 
static void setTimeZoneForDisplays (String timeZone)
 
static void setUseOcrInTranslation (boolean enableOcr)
 
static void setZkServerHost (String hostName)
 
static void setZkServerPort (String port)
 
static boolean showOnlyCurrentUserTags ()
 

Static Public Attributes

static final String DISPLAY_TIMES_IN_LOCAL_TIME = "DisplayTimesInLocalTime"
 
static final String DISPLAY_TRANSLATED_NAMES = "DisplayTranslatedNames"
 
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 EXTERNAL_HEX_EDITOR_PATH = "ExternalHexEditorPath"
 
static final String GROUP_ITEMS_IN_TREE_BY_DATASOURCE = "GroupItemsInTreeByDataSource"
 
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_SCO_COLUMNS = "HideCentralRepoCommentsAndOccurrences"
 
static final String HIDE_SLACK_FILES_IN_DATA_SRCS_TREE = "HideSlackFilesInDataSourcesTree"
 
static final String HIDE_SLACK_FILES_IN_VIEWS_TREE = "HideSlackFilesInViewsTree"
 
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 OCR_TRANSLATION_ENABLED = "OcrTranslationEnabled"
 
static final String PROCESS_TIME_OUT_ENABLED = "ProcessTimeOutEnabled"
 
static final String PROCESS_TIME_OUT_HOURS = "ProcessTimeOutHours"
 
static final String RESULTS_TABLE_PAGE_SIZE = "ResultsTablePageSize"
 
static final String SETTINGS_PROPERTIES = "AutoIngest"
 
static final String SHOW_ONLY_CURRENT_USER_TAGS = "ShowOnlyCurrentUserTags"
 
static final String SOLR_MAX_JVM_SIZE = "SolrMaxJVMSize"
 
static final String TEXT_TRANSLATOR_NAME = "TextTranslatorName"
 
static final String TIME_ZONE_FOR_DISPLAYS = "TimeZoneForDisplays"
 

Private Member Functions

 UserPreferences ()
 

Static Private Member Functions

static String getConfigPreferencePath (String identifier)
 
static String getSharedPreferencePath (String identifier)
 
static File getSystemTempDirFile ()
 

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 int DEFAULT_SOLR_HEAP_SIZE_MB_32BIT_PLATFORM = 512
 
static final int DEFAULT_SOLR_HEAP_SIZE_MB_64BIT_PLATFORM = 2048
 
static final boolean DISPLAY_TRANSLATED_NAMES_DEFAULT = true
 
static final List< String > EXTERNAL_SERVICE_KEYS
 
static final String EXTERNAL_SERVICE_PREFERENCE_PATH = getSharedPreferencePath("ExternalServicePreferences")
 
static final ConfigProperties externalServicePreferences = new ConfigProperties(EXTERNAL_SERVICE_PREFERENCE_PATH)
 
static final String GEO_MBTILES_FILE_PATH = "GeolcoationMBTilesFilePath"
 
static final String GEO_OSM_SERVER_ADDRESS = "GeolocationOsmServerAddress"
 
static final String GEO_OSM_TILE_ZIP_PATH = "GeolocationOsmZipPath"
 
static final String GEO_TILE_OPTION = "GeolocationTileOption"
 
static final String HEALTH_MONITOR_REPORT_PATH = "HealthMonitorReportPath"
 
static final String LEGACY_CONFIG_PATH = Paths.get(PlatformUtil.getUserConfigDirectory(), "Preferences", "org", "sleuthkit", "autopsy", "core.properties").toString()
 
static final int LOG_FILE_NUM_INT = 10
 
static final List< String > MACHINE_PREFERENCE_KEYS
 
static final String MACHINE_SPECIFIC_PREFERENCE_PATH = getConfigPreferencePath("MachineSpecificPreferences")
 
static final ConfigProperties machineSpecificPreferences = new ConfigProperties(MACHINE_SPECIFIC_PREFERENCE_PATH)
 
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 List< String > MODE_PREFERENCE_KEYS
 
static final String MODE_PREFERENCE_PATH = getConfigPreferencePath("ModePreferences")
 
static final ConfigProperties modePreferences = new ConfigProperties(MODE_PREFERENCE_PATH)
 
static Boolean multiUserSupported = null
 
static final String SOLR4_SERVER_HOST = "IndexingServerHost"
 
static final String SOLR4_SERVER_PORT = "IndexingServerPort"
 
static final String SOLR8_SERVER_HOST = "Solr8ServerHost"
 
static final String SOLR8_SERVER_PORT = "Solr8ServerPort"
 
static final String TEMP_FOLDER = "Temp"
 
static final List< String > VIEW_PREFERENCE_KEYS
 
static final String VIEW_PREFERENCE_PATH = getSharedPreferencePath("ViewPreferences")
 
static final ConfigProperties viewPreferences = new ConfigProperties(VIEW_PREFERENCE_PATH)
 
static final String ZK_SERVER_HOST = "ZookeeperServerHost"
 
static final String ZK_SERVER_PORT = "ZookeeperServerPort"
 

Detailed Description

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

Definition at line 49 of file UserPreferences.java.

Constructor & Destructor Documentation

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

Definition at line 266 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
static boolean org.sleuthkit.autopsy.core.UserPreferences.displayTranslatedFileNames ( )
static
static String org.sleuthkit.autopsy.core.UserPreferences.getAppName ( )
static
static String org.sleuthkit.autopsy.core.UserPreferences.getAppTempDirectory ( )
static
static String org.sleuthkit.autopsy.core.UserPreferences.getConfigPreferencePath ( String  identifier)
staticprivate

Returns the path to the preferences for the identifier in the user config directory.

Parameters
identifierThe identifier.
Returns
The path to the preference file.

Definition at line 59 of file UserPreferences.java.

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

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 724 of file UserPreferences.java.

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

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

Retrieves the HdXEditor path set by the User. If not found, the default will be the default install location of HxD.

Returns
Path to HdX

Definition at line 794 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.BackgroundFileCopyTask.doInBackground().

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

Retrieves the path for the Geolocation MBTiles data source file.

Returns
Absolute path to MBTiles file or empty string if none was found.

Definition at line 869 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.geolocation.MapPanel.getTileFactory().

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

Retrieves the address to the OSM server or null if one was not found.

Returns
Address of OSM server

Definition at line 851 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.geolocation.MapPanel.getTileFactory().

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

Retrieves the path for the OSM tile zip file or returns empty string if none was found.

Returns
Path to zip file

Definition at line 832 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.geolocation.MapPanel.getTileFactory().

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

Retrieves the Geolocation tile option. If not found, the value will default to 0.

Returns

Definition at line 813 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.geolocation.MapPanel.getTileFactory().

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

Gets the last used health monitor report path.

Returns
Last used health monitor report path. Empty string if no value has been recorded.

Definition at line 929 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.healthmonitor.HealthMonitorDashboard.createUserControlPanel().

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

Get the user preference which identifies whether the (S)core, (C)omments, and (O)ccurrences columns should be populated and displayed in the result view.

Returns
True if hiding SCO columns; otherwise false.

Definition at line 438 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.datamodel.OsAccounts.OsAccountNode.addSCOColumns(), org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.addSCOColumns(), org.sleuthkit.autopsy.commonpropertiessearch.InstanceCountNode.createSheet(), org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.getProperties(), and org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load().

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 676 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 715 of file UserPreferences.java.

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

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

Get the maximum JVM heap size (in MB) for the embedded Solr server. The returned value depends on the platform (64bit vs 32bit).

Returns
Saved value or default (2 GB for 64bit platforms, 512MB for 32bit)

Definition at line 744 of file UserPreferences.java.

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

Referenced by org.sleuthkit.autopsy.keywordsearch.Server.runLocalSolr4ControlCommand(), and org.sleuthkit.autopsy.keywordsearch.Server.runLocalSolr8ControlCommand().

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 649 of file UserPreferences.java.

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

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

Get the maximum number of results to display in a result table.

Returns
Saved value or default (10,000).

Definition at line 766 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load().

static String org.sleuthkit.autopsy.core.UserPreferences.getSharedPreferencePath ( String  identifier)
staticprivate

Returns the path to the preferences for the identifier in the shared preference directory.

Parameters
identifierThe identifier.
Returns
The path to the preference file.

Definition at line 71 of file UserPreferences.java.

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

static String org.sleuthkit.autopsy.core.UserPreferences.getSolr4ServerHost ( )
static
static String org.sleuthkit.autopsy.core.UserPreferences.getSolr4ServerPort ( )
static
static File org.sleuthkit.autopsy.core.UserPreferences.getSystemTempDirFile ( )
staticprivate
static String org.sleuthkit.autopsy.core.UserPreferences.getTextTranslatorName ( )
static

Definition at line 587 of file UserPreferences.java.

static String org.sleuthkit.autopsy.core.UserPreferences.getTimeZoneForDisplays ( )
static
static boolean org.sleuthkit.autopsy.core.UserPreferences.getUseOcrInTranslation ( )
static
static String org.sleuthkit.autopsy.core.UserPreferences.getZkServerHost ( )
static
static String org.sleuthkit.autopsy.core.UserPreferences.getZkServerPort ( )
static
static boolean org.sleuthkit.autopsy.core.UserPreferences.groupItemsInTreeByDatasource ( )
static

Definition at line 402 of file UserPreferences.java.

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
static boolean org.sleuthkit.autopsy.core.UserPreferences.isMultiUserSupported ( )
static

Checks to see if SolrSearchService is a registered AutopsyService. If the module is not found, the keyword search module and solr services have likely been excluded from the build. In that event, services relying on Solr (a.k.a. multiuser cases) will be disabled.

Returns
True if multi user cases are supported.

Definition at line 525 of file UserPreferences.java.

References org.sleuthkit.autopsy.core.UserPreferences.multiUserSupported.

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

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 302 of file UserPreferences.java.

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

Definition at line 330 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 316 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 706 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setDatabaseConnectionInfo ( CaseDbConnectionInfo  connectionInfo) throws UserPreferencesException
static
static void org.sleuthkit.autopsy.core.UserPreferences.setDisplayTimesInLocalTime ( boolean  value)
static
static void org.sleuthkit.autopsy.core.UserPreferences.setDisplayTranslatedFileNames ( boolean  value)
static
static void org.sleuthkit.autopsy.core.UserPreferences.setExternalHexEditorPath ( String  executablePath)
static

Set the HdX path.

Parameters
executablePathUser-inputted path to HxD executable

Definition at line 784 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setGeolocationMBTilesFilePath ( String  absolutePath)
static

Sets the path for Geolocation MBTiles data source file.

Parameters
absolutePath

Definition at line 860 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setGeolocationOsmServerAddress ( String  address)
static

Sets the address of geolocation window user defined OSM server data source.

Parameters
address

Definition at line 842 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setGeolocationOsmZipPath ( String  absolutePath)
static

Sets the path to the OSM tile zip file.

Parameters
absolutePath

Definition at line 822 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setGeolocationTileOption ( int  option)
static

Set the geolocation tile server option.

Parameters
option

Definition at line 803 of file UserPreferences.java.

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

Definition at line 407 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setHealthMonitorReportPath ( String  reportPath)
static

Set the last used health monitor report path.

Parameters
reportPathLast used health monitor report path.

Definition at line 919 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.healthmonitor.HealthMonitorDashboard.createUserControlPanel().

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

Set the user preference which identifies whether the (S)core, (C)omments, and (O)ccurrences columns should be populated and displayed in the result view.

Parameters
valueThe value of which to assign to the user preference.

Definition at line 449 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.scoColumnsCheckboxActionPerformed(), and org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.store().

static void org.sleuthkit.autopsy.core.UserPreferences.setHideSlackFilesInDataSourcesTree ( boolean  value)
static
static void org.sleuthkit.autopsy.core.UserPreferences.setHideSlackFilesInViewsTree ( boolean  value)
static
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 688 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setKeepPreferredContentViewer ( boolean  value)
static
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 733 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setMaxSolrVMSize ( int  maxSize)
static

Set the maximum JVM heap size (in MB) for the embedded Solr server.

Parameters
maxSize

Definition at line 757 of file UserPreferences.java.

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

Set mode to persistent storage.

Parameters
modeSelected mode.

Definition at line 292 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 397 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 662 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setResultsTablePageSize ( int  pageSize)
static

Set the maximum number of results to display in a result table.

Parameters
pageSize

Definition at line 775 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.maxResultsSpinnerStateChanged(), and org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.store().

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

Set the user preference which identifies whether tags should be shown for only the current user or all users.

Parameters
value- true for just the current user, false for all users

Definition at line 427 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.hideOtherUsersTagsCheckboxActionPerformed(), and org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.store().

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

Definition at line 555 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setSolr4ServerPort ( String  port)
static

Definition at line 563 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setTextTranslatorName ( String  textTranslatorName)
static

Definition at line 583 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setTimeZoneForDisplays ( String  timeZone)
static
static void org.sleuthkit.autopsy.core.UserPreferences.setUseOcrInTranslation ( boolean  enableOcr)
static

Definition at line 591 of file UserPreferences.java.

static void org.sleuthkit.autopsy.core.UserPreferences.setZkServerHost ( String  hostName)
static
static void org.sleuthkit.autopsy.core.UserPreferences.setZkServerPort ( String  port)
static
static boolean org.sleuthkit.autopsy.core.UserPreferences.showOnlyCurrentUserTags ( )
static

Member Data Documentation

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

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

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

Definition at line 122 of file UserPreferences.java.

final int org.sleuthkit.autopsy.core.UserPreferences.DEFAULT_SOLR_HEAP_SIZE_MB_32BIT_PLATFORM = 512
staticprivate

Definition at line 127 of file UserPreferences.java.

final int org.sleuthkit.autopsy.core.UserPreferences.DEFAULT_SOLR_HEAP_SIZE_MB_64BIT_PLATFORM = 2048
staticprivate

Definition at line 126 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.DISPLAY_TRANSLATED_NAMES = "DisplayTranslatedNames"
static
final boolean org.sleuthkit.autopsy.core.UserPreferences.DISPLAY_TRANSLATED_NAMES_DEFAULT = true
staticprivate

Definition at line 114 of file UserPreferences.java.

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

Definition at line 142 of file UserPreferences.java.

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

Definition at line 144 of file UserPreferences.java.

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

Definition at line 146 of file UserPreferences.java.

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

Definition at line 143 of file UserPreferences.java.

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

Definition at line 147 of file UserPreferences.java.

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

Definition at line 145 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.EXTERNAL_HEX_EDITOR_PATH = "ExternalHexEditorPath"
static

Definition at line 115 of file UserPreferences.java.

final List<String> org.sleuthkit.autopsy.core.UserPreferences.EXTERNAL_SERVICE_KEYS
staticprivate
final String org.sleuthkit.autopsy.core.UserPreferences.EXTERNAL_SERVICE_PREFERENCE_PATH = getSharedPreferencePath("ExternalServicePreferences")
staticprivate

Definition at line 78 of file UserPreferences.java.

final ConfigProperties org.sleuthkit.autopsy.core.UserPreferences.externalServicePreferences = new ConfigProperties(EXTERNAL_SERVICE_PREFERENCE_PATH)
staticprivate

Definition at line 83 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.GEO_MBTILES_FILE_PATH = "GeolcoationMBTilesFilePath"
staticprivate

Definition at line 131 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.GEO_OSM_SERVER_ADDRESS = "GeolocationOsmServerAddress"
staticprivate

Definition at line 161 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.GEO_OSM_TILE_ZIP_PATH = "GeolocationOsmZipPath"
staticprivate

Definition at line 130 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.GEO_TILE_OPTION = "GeolocationTileOption"
staticprivate

Definition at line 140 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.GROUP_ITEMS_IN_TREE_BY_DATASOURCE = "GroupItemsInTreeByDataSource"
static

Definition at line 110 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.HEALTH_MONITOR_REPORT_PATH = "HealthMonitorReportPath"
staticprivate

Definition at line 128 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_SCO_COLUMNS = "HideCentralRepoCommentsAndOccurrences"
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.IS_MULTI_USER_MODE_ENABLED = "IsMultiUserModeEnabled"
static

Definition at line 139 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.KEEP_PREFERRED_VIEWER = "KeepPreferredViewer"
static
final String org.sleuthkit.autopsy.core.UserPreferences.LEGACY_CONFIG_PATH = Paths.get(PlatformUtil.getUserConfigDirectory(), "Preferences", "org", "sleuthkit", "autopsy", "core.properties").toString()
staticprivate

Definition at line 225 of file UserPreferences.java.

final int org.sleuthkit.autopsy.core.UserPreferences.LOG_FILE_NUM_INT = 10
staticprivate
final List<String> org.sleuthkit.autopsy.core.UserPreferences.MACHINE_PREFERENCE_KEYS
staticprivate
final String org.sleuthkit.autopsy.core.UserPreferences.MACHINE_SPECIFIC_PREFERENCE_PATH = getConfigPreferencePath("MachineSpecificPreferences")
staticprivate

Definition at line 76 of file UserPreferences.java.

final ConfigProperties org.sleuthkit.autopsy.core.UserPreferences.machineSpecificPreferences = new ConfigProperties(MACHINE_SPECIFIC_PREFERENCE_PATH)
staticprivate

Definition at line 81 of file UserPreferences.java.

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

Definition at line 123 of file UserPreferences.java.

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

Definition at line 156 of file UserPreferences.java.

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

Definition at line 154 of file UserPreferences.java.

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

Definition at line 157 of file UserPreferences.java.

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

Definition at line 155 of file UserPreferences.java.

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

Definition at line 135 of file UserPreferences.java.

final List<String> org.sleuthkit.autopsy.core.UserPreferences.MODE_PREFERENCE_KEYS
staticprivate
Initial value:
= Arrays.asList(
)

Definition at line 194 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.MODE_PREFERENCE_PATH = getConfigPreferencePath("ModePreferences")
staticprivate

Definition at line 77 of file UserPreferences.java.

final ConfigProperties org.sleuthkit.autopsy.core.UserPreferences.modePreferences = new ConfigProperties(MODE_PREFERENCE_PATH)
staticprivate

Definition at line 82 of file UserPreferences.java.

Boolean org.sleuthkit.autopsy.core.UserPreferences.multiUserSupported = null
staticprivate
final String org.sleuthkit.autopsy.core.UserPreferences.NUMBER_OF_FILE_INGEST_THREADS = "NumberOfFileIngestThreads"
static

Definition at line 119 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.OCR_TRANSLATION_ENABLED = "OcrTranslationEnabled"
static

Definition at line 141 of file UserPreferences.java.

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

Definition at line 120 of file UserPreferences.java.

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

Definition at line 121 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.RESULTS_TABLE_PAGE_SIZE = "ResultsTablePageSize"
static
final String org.sleuthkit.autopsy.core.UserPreferences.SETTINGS_PROPERTIES = "AutoIngest"
static
final String org.sleuthkit.autopsy.core.UserPreferences.SHOW_ONLY_CURRENT_USER_TAGS = "ShowOnlyCurrentUserTags"
static
final String org.sleuthkit.autopsy.core.UserPreferences.SOLR4_SERVER_HOST = "IndexingServerHost"
staticprivate

Definition at line 150 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.SOLR4_SERVER_PORT = "IndexingServerPort"
staticprivate

Definition at line 151 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.SOLR8_SERVER_HOST = "Solr8ServerHost"
staticprivate

Definition at line 148 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.SOLR8_SERVER_PORT = "Solr8ServerPort"
staticprivate

Definition at line 149 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.SOLR_MAX_JVM_SIZE = "SolrMaxJVMSize"
static

Definition at line 125 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.TEMP_FOLDER = "Temp"
staticprivate
final String org.sleuthkit.autopsy.core.UserPreferences.TEXT_TRANSLATOR_NAME = "TextTranslatorName"
static
final String org.sleuthkit.autopsy.core.UserPreferences.TIME_ZONE_FOR_DISPLAYS = "TimeZoneForDisplays"
static
final List<String> org.sleuthkit.autopsy.core.UserPreferences.VIEW_PREFERENCE_KEYS
staticprivate
final String org.sleuthkit.autopsy.core.UserPreferences.VIEW_PREFERENCE_PATH = getSharedPreferencePath("ViewPreferences")
staticprivate

Definition at line 75 of file UserPreferences.java.

final ConfigProperties org.sleuthkit.autopsy.core.UserPreferences.viewPreferences = new ConfigProperties(VIEW_PREFERENCE_PATH)
staticprivate

Definition at line 80 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.ZK_SERVER_HOST = "ZookeeperServerHost"
staticprivate

Definition at line 152 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.ZK_SERVER_PORT = "ZookeeperServerPort"
staticprivate

Definition at line 153 of file UserPreferences.java.


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

Copyright © 2012-2022 Basis Technology. Generated on: Sat Sep 24 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.