Autopsy  4.12.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 boolean displayTranslatedFileNames ()
 
static String getAppName ()
 
static CaseDbConnectionInfo getDatabaseConnectionInfo () throws UserPreferencesException
 
static int getDefaultLogFileCount ()
 
static String getExternalHexEditorPath ()
 
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 getTextTranslatorName ()
 
static String getTimeZoneForDisplays ()
 
static boolean groupItemsInTreeByDatasource ()
 
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 setDisplayTranslatedFileNames (boolean value)
 
static void setExternalHexEditorPath (String executablePath)
 
static void setGroupItemsInTreeByDatasource (boolean value)
 
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 setTextTranslatorName (String textTranslatorName)
 
static void setTimeZoneForDisplays (String timeZone)
 
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 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 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 TIME_ZONE_FOR_DISPLAYS = "TimeZoneForDisplays"
 

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 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)
 
static final String TEXT_TRANSLATOR_NAME = "TextTranslatorName"
 

Detailed Description

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

Definition at line 39 of file UserPreferences.java.

Constructor & Destructor Documentation

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

Definition at line 83 of file UserPreferences.java.

Member Function Documentation

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

Definition at line 135 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.communications.FiltersPanel.FiltersPanel(), org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.initializePagingSupport(), and org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.subscribeToChangeEvents().

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

Definition at line 183 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.communications.Utils.getUserPreferredZoneId(), and org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load().

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

Definition at line 263 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.getProperties(), and org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load().

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

Get the display name for this program

Returns
Name of this program

Definition at line 443 of file UserPreferences.java.

References org.sleuthkit.autopsy.coreutils.Version.getName().

Referenced by org.sleuthkit.autopsy.casemodule.Case.getAppName(), org.sleuthkit.autopsy.casemodule.Case.getNameForTitle(), and org.sleuthkit.autopsy.livetriage.CreateLiveTriageDriveAction.performAction().

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

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

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkDatabaseConnectionStatus(), org.sleuthkit.autopsy.casemodule.Case.createCaseDatabase(), org.sleuthkit.autopsy.healthmonitor.HealthMonitor.createDatabase(), org.sleuthkit.autopsy.healthmonitor.HealthMonitor.databaseExists(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDatabase(), org.sleuthkit.autopsy.casemodule.SingleUserCaseConverter.ImportCaseData.ImportCaseData(), org.sleuthkit.autopsy.casemodule.Case.openCaseDataBase(), and org.sleuthkit.autopsy.healthmonitor.HealthMonitor.setupConnectionPool().

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

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

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

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

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

Definition at line 321 of file UserPreferences.java.

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

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

Definition at line 329 of file UserPreferences.java.

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

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

Definition at line 317 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.casemodule.CaseOpenAction.actionPerformed(), org.sleuthkit.autopsy.healthmonitor.HealthMonitor.activateMonitorLocally(), org.sleuthkit.autopsy.core.ServicesMonitor.checkAllServices(), org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase(), 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 422 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 461 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.

Returns
Saved value or default (512)

Definition at line 488 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.Server.runSolrCommand().

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

References org.sleuthkit.autopsy.coreutils.TextConverter.convertHexTextToText(), and org.sleuthkit.autopsy.core.UserPreferences.DEFAULT_PORT_INT.

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

static SelectedMode org.sleuthkit.autopsy.core.UserPreferences.getMode ( )
static

Get mode from persistent storage.

Returns
SelectedMode Selected mode.

Definition at line 97 of file UserPreferences.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), org.sleuthkit.autopsy.coreutils.ModuleSettings.settingExists(), and org.sleuthkit.autopsy.core.UserPreferences.SelectedMode.STANDALONE.

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

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

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

Definition at line 341 of file UserPreferences.java.

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

Definition at line 191 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.datamodel.ContentUtils.getTimeZone(), org.sleuthkit.autopsy.communications.Utils.getUserPreferredZoneId(), and org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load().

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

Definition at line 208 of file UserPreferences.java.

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

Definition at line 151 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load(), and org.sleuthkit.autopsy.directorytree.ViewContextAction.ViewContextAction().

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

Definition at line 159 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.datamodel.FileTypesByExtension.createQuery(), and org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load().

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

Definition at line 167 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load(), and org.sleuthkit.autopsy.directorytree.ViewContextAction.ViewContextAction().

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

Definition at line 175 of file UserPreferences.java.

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

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

Definition at line 143 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load(), org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewerPanel.setupTabs(), and org.sleuthkit.autopsy.corecomponents.DataContentPanel.setupTabs().

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

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

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

Definition at line 139 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 131 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 452 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 301 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 187 of file UserPreferences.java.

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

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

Definition at line 259 of file UserPreferences.java.

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

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

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

Definition at line 213 of file UserPreferences.java.

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

Definition at line 155 of file UserPreferences.java.

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

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

Definition at line 163 of file UserPreferences.java.

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

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 255 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

Definition at line 171 of file UserPreferences.java.

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

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

Definition at line 179 of file UserPreferences.java.

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

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

Definition at line 325 of file UserPreferences.java.

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

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

Definition at line 333 of file UserPreferences.java.

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

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

Definition at line 313 of file UserPreferences.java.

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

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

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

Definition at line 147 of file UserPreferences.java.

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

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 479 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 497 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 352 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 110 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 203 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 408 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 515 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 233 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.setTextTranslatorName ( String  textTranslatorName)
static

Definition at line 337 of file UserPreferences.java.

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

Definition at line 195 of file UserPreferences.java.

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

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

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

Returns
true for just the current user, false for all users

Definition at line 223 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.datamodel.Tags.TagNameNodeFactory.createKeys(), org.sleuthkit.autopsy.datamodel.Tags.ContentTagNodeFactory.createKeys(), org.sleuthkit.autopsy.datamodel.Tags.BlackboardArtifactTagNodeFactory.createKeys(), org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load(), org.sleuthkit.autopsy.datamodel.Tags.TagNameNode.updateDisplayName(), org.sleuthkit.autopsy.datamodel.Tags.ContentTagTypeNode.updateDisplayName(), and org.sleuthkit.autopsy.datamodel.Tags.BlackboardArtifactTagTypeNode.updateDisplayName().

Member Data Documentation

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

Definition at line 69 of file UserPreferences.java.

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

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

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

Definition at line 66 of file UserPreferences.java.

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

Definition at line 47 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.communications.FiltersPanel.FiltersPanel(), and org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.subscribeToChangeEvents().

final String org.sleuthkit.autopsy.core.UserPreferences.DISPLAY_TRANSLATED_NAMES = "DisplayTranslatedNames"
static

Definition at line 77 of file UserPreferences.java.

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

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

Definition at line 51 of file UserPreferences.java.

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

Definition at line 53 of file UserPreferences.java.

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

Definition at line 55 of file UserPreferences.java.

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

Definition at line 52 of file UserPreferences.java.

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

Definition at line 56 of file UserPreferences.java.

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

Definition at line 54 of file UserPreferences.java.

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

Definition at line 78 of file UserPreferences.java.

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

Definition at line 74 of file UserPreferences.java.

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

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

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

final String org.sleuthkit.autopsy.core.UserPreferences.HIDE_SCO_COLUMNS = "HideCentralRepoCommentsAndOccurrences"
static

Definition at line 76 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 45 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 46 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 57 of file UserPreferences.java.

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

Definition at line 58 of file UserPreferences.java.

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

Definition at line 50 of file UserPreferences.java.

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

Definition at line 42 of file UserPreferences.java.

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

final int org.sleuthkit.autopsy.core.UserPreferences.LOG_FILE_NUM_INT = 10
staticprivate

Definition at line 73 of file UserPreferences.java.

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

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

Definition at line 72 of file UserPreferences.java.

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

Definition at line 61 of file UserPreferences.java.

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

Definition at line 59 of file UserPreferences.java.

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

Definition at line 62 of file UserPreferences.java.

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

Definition at line 60 of file UserPreferences.java.

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

Definition at line 71 of file UserPreferences.java.

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

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

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

Definition at line 65 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.RESULTS_TABLE_PAGE_SIZE = "ResultsTablePageSize"
static

Definition at line 80 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.initializePagingSupport().

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

Definition at line 70 of file UserPreferences.java.

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

final String org.sleuthkit.autopsy.core.UserPreferences.SHOW_ONLY_CURRENT_USER_TAGS = "ShowOnlyCurrentUserTags"
static

Definition at line 75 of file UserPreferences.java.

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

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

Definition at line 79 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.TEXT_TRANSLATOR_NAME = "TextTranslatorName"
staticprivate

Definition at line 63 of file UserPreferences.java.

final String org.sleuthkit.autopsy.core.UserPreferences.TIME_ZONE_FOR_DISPLAYS = "TimeZoneForDisplays"
static

Definition at line 48 of file UserPreferences.java.

Referenced by org.sleuthkit.autopsy.communications.FiltersPanel.FiltersPanel(), and org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.subscribeToChangeEvents().

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

Copyright © 2012-2018 Basis Technology. Generated on: Wed Sep 18 2019
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.