Remote Systems
v6.4.1

com.ibm.etools.systems.core
Class SystemPreferencesManager

java.lang.Object
  extended bycom.ibm.etools.systems.core.SystemPreferencesManager
All Implemented Interfaces:
ISystemPreferencesConstants

public class SystemPreferencesManager
extends Object
implements ISystemPreferencesConstants

A class that encapsulates all global preferences for the remote system framework

These include:


Field Summary
static String copyright
           
 
Fields inherited from interface com.ibm.etools.systems.core.ISystemPreferencesConstants
ACTIVEUSERPROFILES, CASCADE_UDAS_BYPROFILE, DAEMON_AUTOSTART, DAEMON_PORT, DEFAULT_ACTIVEUSERPROFILES, DEFAULT_CASCADE_UDAS_BYPROFILE, DEFAULT_DAEMON_AUTOSTART, DEFAULT_DAEMON_PORT, DEFAULT_DOSUPERTRANSFER, DEFAULT_DOWNLOAD_BUFFER_SIZE, DEFAULT_FILETRANSFERMODE, DEFAULT_HISTORY_FOLDER, DEFAULT_LIMIT_CACHE, DEFAULT_MAX_CACHE_SIZE, DEFAULT_ORDER_CONNECTIONS, DEFAULT_QUALIFY_CONNECTION_NAMES, DEFAULT_REMEMBER_STATE, DEFAULT_RESTORE_STATE_FROM_CACHE, DEFAULT_SHOW_HIDDEN, DEFAULT_SHOWFILTERPOOLS, DEFAULT_SHOWNEWCONNECTIONPROMPT, DEFAULT_SUPERTRANSFER_ARCHIVE_TYPE, DEFAULT_SYSTEMTYPE, DEFAULT_TEAMPROFILE, DEFAULT_USERID, DEFAULT_VERIFY_CONNECTION, DFFAULT_PRIVATEPROFILE, DOSUPERTRANSFER, DOWNLOAD_BUFFER_SIZE, FILETRANSFERMODE_BINARY, FILETRANSFERMODE_TEXT, FILETRANSFERMODEDEFAULT, HISTORY_FOLDER, HISTORY_QUALIFIED_FOLDER, LIMIT_CACHE, MAX_CACHE_SIZE, ORDER_CONNECTIONS, QUALIFY_CONNECTION_NAMES, REMEMBER_STATE, RESTORE_STATE_FROM_CACHE, ROOT, SHOWFILTERPOOLS, SHOWHIDDEN, SHOWNEWCONNECTIONPROMPT, SUPERTRANSFER_ARC_TYPE, SYSTEMTYPE, SYSTEMTYPE_VALUES, UPLOAD_BUFFER_SIZE, USE_DEFERRED_QUERIES, USERIDKEYS, USERIDPERKEY, VERIFY_CONNECTION
 
Constructor Summary
protected SystemPreferencesManager()
           
 
Method Summary
 void addActiveProfile(String newName)
          Add a name to the active profile list
 void clearUserId(String key)
          Clear the user Id for the given key
 void deleteActiveProfile(String oldName)
          Delete one of the active profile names in the list of names stored in the registry.
 String[] getActiveProfileNames()
          Return active profile names
 int getActiveProfilePosition(String profileName)
          Return the position of a give profile name in the active list
 boolean getCascadeUserActions()
          Return whether to cascade user actions menu by profile
 String[] getConnectionNamesOrder(String profileName)
          Returns user's preference for the order of the connection names
 String[] getConnectionNamesOrder(SystemConnection[] realityConnectionList, String profileName)
          Returns user's preference for the order of the connection names, after resolving it with the reality list of connection names.
 String getDefaultUserId(String systemType)
          Return user Id per system type
 String[] getFolderHistory()
          Return history for the folder combobox
static SystemPreferencesManager getPreferencesManager()
          Get singleton of this class
 boolean getQualifyConnectionNames()
          Return whether to show connection names qualified by profile name
 boolean getRememberState()
          Return whether to remember state or not in Remote Systems view
 boolean getShowFilterPools()
          Return whether to show filter pools or not
 boolean getShowNewConnectionPrompt()
          Return whether to show "New Connection..." prompt
 String getUserId(String key)
          Return user Id per key
 boolean getVerifyConnection()
          Return whether to turn on "Verify connection" checkbox on the New Connection wizard
 String[] getWidgetHistory(String key)
          Return history for a widget given a key that uniquely identifies it
 void renameActiveProfile(String oldName, String newName)
          Rename one of the active profile names in the list of names stored in the registry.
 String[] resolveOrderPreferenceVersusReality(String[] reality, String[] ordered)
          Helper method to resolve differences between two ordered name lists.
 void setCascadeUserActions(boolean cascade)
          Set whether to cascade user actions menu by profile
 void setConnectionNamesOrder()
          Set user's preference for the order of the connection names
 void setConnectionNamesOrder(String[] names)
          Set user's preference for the order of the connection names
 void setDefaultUserId(String systemType, String userId)
          Set user Id per system type
 void setFolderHistory(String[] history)
          Set history for the folder combobox
 void setQualifyConnectionNames(boolean set)
          Set whether to show connection names qualified by profile name
 void setRememberState(boolean remember)
          Set whether to remember state or not in Remote Systems view
 void setShowFilterPools(boolean show)
          Set whether to show filter pools or not
 void setShowNewConnectionPrompt(boolean show)
          Set whether to show "New Connection..." prompt
 void setUserId(String key, String userId)
          Set the user Id per key
 void setVerifyConnection(boolean verify)
          Set whether to turn on "Verify connection" checkbox on the New Connection wizard
 void setWidgetHistory(String key, String[] history)
          Set history for a widget given a key that uniquely identifies it
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Constructor Detail

SystemPreferencesManager

protected SystemPreferencesManager()
Method Detail

getPreferencesManager

public static SystemPreferencesManager getPreferencesManager()
Get singleton of this class


getActiveProfileNames

public String[] getActiveProfileNames()
Return active profile names


renameActiveProfile

public void renameActiveProfile(String oldName,
                                String newName)
Rename one of the active profile names in the list of names stored in the registry.


deleteActiveProfile

public void deleteActiveProfile(String oldName)
Delete one of the active profile names in the list of names stored in the registry.


addActiveProfile

public void addActiveProfile(String newName)
Add a name to the active profile list


getActiveProfilePosition

public int getActiveProfilePosition(String profileName)
Return the position of a give profile name in the active list


getConnectionNamesOrder

public String[] getConnectionNamesOrder(String profileName)
Returns user's preference for the order of the connection names


getConnectionNamesOrder

public String[] getConnectionNamesOrder(SystemConnection[] realityConnectionList,
                                        String profileName)
Returns user's preference for the order of the connection names, after resolving it with the reality list of connection names.


setConnectionNamesOrder

public void setConnectionNamesOrder(String[] names)
Set user's preference for the order of the connection names


setConnectionNamesOrder

public void setConnectionNamesOrder()
Set user's preference for the order of the connection names


resolveOrderPreferenceVersusReality

public String[] resolveOrderPreferenceVersusReality(String[] reality,
                                                    String[] ordered)
Helper method to resolve differences between two ordered name lists. Used when there are differences between the actual list of names and a restored ordered list of names.


getDefaultUserId

public String getDefaultUserId(String systemType)
Return user Id per system type


setDefaultUserId

public void setDefaultUserId(String systemType,
                             String userId)
Set user Id per system type


getUserId

public String getUserId(String key)
Return user Id per key


setUserId

public void setUserId(String key,
                      String userId)
Set the user Id per key


clearUserId

public void clearUserId(String key)
Clear the user Id for the given key


getQualifyConnectionNames

public boolean getQualifyConnectionNames()
Return whether to show connection names qualified by profile name


getShowFilterPools

public boolean getShowFilterPools()
Return whether to show filter pools or not


getRememberState

public boolean getRememberState()
Return whether to remember state or not in Remote Systems view


getShowNewConnectionPrompt

public boolean getShowNewConnectionPrompt()
Return whether to show "New Connection..." prompt


getCascadeUserActions

public boolean getCascadeUserActions()
Return whether to cascade user actions menu by profile


getVerifyConnection

public boolean getVerifyConnection()
Return whether to turn on "Verify connection" checkbox on the New Connection wizard


setQualifyConnectionNames

public void setQualifyConnectionNames(boolean set)
Set whether to show connection names qualified by profile name


setShowFilterPools

public void setShowFilterPools(boolean show)
Set whether to show filter pools or not


setRememberState

public void setRememberState(boolean remember)
Set whether to remember state or not in Remote Systems view


setShowNewConnectionPrompt

public void setShowNewConnectionPrompt(boolean show)
Set whether to show "New Connection..." prompt


setCascadeUserActions

public void setCascadeUserActions(boolean cascade)
Set whether to cascade user actions menu by profile


setVerifyConnection

public void setVerifyConnection(boolean verify)
Set whether to turn on "Verify connection" checkbox on the New Connection wizard


getFolderHistory

public String[] getFolderHistory()
Return history for the folder combobox


setFolderHistory

public void setFolderHistory(String[] history)
Set history for the folder combobox


getWidgetHistory

public String[] getWidgetHistory(String key)
Return history for a widget given a key that uniquely identifies it


setWidgetHistory

public void setWidgetHistory(String key,
                             String[] history)
Set history for a widget given a key that uniquely identifies it


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.