org.eclipse.rse.core
Class RSEPreferencesManager

java.lang.Object
  org.eclipse.rse.core.RSEPreferencesManager

public class RSEPreferencesManager
extends Object

Method Summary

static void	addActiveProfile(String newName) Add a name to the active profile list.
static void	clearUserId(String key) Clears the user ID for the given key.
static void	deleteActiveProfile(String oldName) Delete one of the active profile names in the list of names stored in the registry.
static int	getActiveProfilePosition(String profileName)
static String[]	getActiveProfiles()
static String	getDefaultPrivateSystemProfileName()
static String	getDefaultTeamProfileName()
static String	getDefaultUserId(IRSESystemType systemType) Gets the default user id for a given system type.
static boolean	getIsSystemTypeEnabled(IRSESystemType systemType) Gets the enabled state for a particular system type.
static String	getSystemTypeValues() Gets the system type values table for editing.
static String	getUserId(String key) Retrieves a user id given a key.
static void	initDefaults()
static void	renameActiveProfile(String oldName, String newName) Renames one of the active profile names in the list of names stored in the registry.
static void	setDefaultUserId(IRSESystemType systemType, String userId) Sets the default userId for the given system type.
static void	setIsSystemTypeEnabled(IRSESystemType systemType, boolean isEnabled) Sets if a system type is enabled.
static void	setSystemTypeValues(String systemTypeValues) Sets the default user id and enabled state for all system types.
static void	setUserId(String key, String userId) Sets the user Id for this key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUserId

public static String getUserId(String key)

Retrieves a user id given a key.

Parameters:

key - the key from which to get the particular user id.

Returns:

user ID for the given key or null if the key was not found.

See Also:

setUserId(String, String)

clearUserId

public static void clearUserId(String key)

Clears the user ID for the given key.

Parameters:

key - the key for the user id.

See Also:

setUserId(String, String)

setUserId

public static void setUserId(String key,
                             String userId)

Sets the user Id for this key. The key typically designates a scope for this userid so that a hierarchy of user ids can be maintained for inheritance. For example, hosts have greater scope than subsystems. A key would typically be ., or ., or ...

Parameters:

key - the key used to find the userId

userId - the userId to retrieve by this key.

getDefaultUserId

public static String getDefaultUserId(IRSESystemType systemType)

Gets the default user id for a given system type.

Parameters:

systemType - the systemtype for which to retrieve the default user id

Returns:

The default user id

setDefaultUserId

public static void setDefaultUserId(IRSESystemType systemType,
                                    String userId)

Sets the default userId for the given system type.

Parameters:

systemType - the system type for which to set the default

userId - the default user id for this system type. This may be null to "unset" the default.

getSystemTypeValues

public static String getSystemTypeValues()

Gets the system type values table for editing. This is a synthesized preference that is handled as a single value. Rows are separated by semi-colons. Each row is of the format =+;

Returns:

the table of system types formatted as a single string

setSystemTypeValues

public static void setSystemTypeValues(String systemTypeValues)

Sets the default user id and enabled state for all system types.

Parameters:

systemTypeValues - a tabled encoded as a string that contains entries for each system type. See getSystemTypeValues() for the table format.

setIsSystemTypeEnabled

public static void setIsSystemTypeEnabled(IRSESystemType systemType,
                                          boolean isEnabled)

Sets if a system type is enabled.

Parameters:

systemType - the system type to be enabled on this machine.

isEnabled - the enabled state

getIsSystemTypeEnabled

public static boolean getIsSystemTypeEnabled(IRSESystemType systemType)

Gets the enabled state for a particular system type.

Parameters:

systemType - the system type

Returns:

the enabled state of that type

getActiveProfiles

public static String[] getActiveProfiles()

Returns:

the names of the profiles the user has elected to make active.

addActiveProfile

public static void addActiveProfile(String newName)

Add a name to the active profile list. A name already in the list is not added again. The list remains sorted in the natural order.

Parameters:

newName - a new active profile name

deleteActiveProfile

public static void deleteActiveProfile(String oldName)

Delete one of the active profile names in the list of names stored in the registry.

Parameters:

oldName - the name of the profile to remove from the active profiles list.

getActiveProfilePosition

public static int getActiveProfilePosition(String profileName)

Parameters:

profileName - the name of the profile to search for in the list of active profiles.

Returns:

the zero-based position of a give profile name in the active list

renameActiveProfile

public static void renameActiveProfile(String oldName,
                                       String newName)

Renames one of the active profile names in the list of names stored in the registry. This is usually employed after renaming a profile to ensure that the active names list stays in synch with the actual profile names. The active state of the profiles cannot be kept in the profiles themselves since that can vary from workspace to workspace for profiles that are shared in a team.

Parameters:

oldName - the old name of the profile

newName - the new name of the profile

initDefaults

public static void initDefaults()

getDefaultPrivateSystemProfileName

public static String getDefaultPrivateSystemProfileName()

Returns:

The name of the default private system profile. This is typically the short name of the host machine or the name of the user account.

getDefaultTeamProfileName

public static String getDefaultTeamProfileName()

Returns:

the name of the default team system profile.