com.novell.emframe.dev.config

Class UserConfig

java.lang.Object

com.novell.emframe.dev.config.UserConfig

public class UserConfig
extends java.lang.Object

The UserConfig class is used to read and write module or task settings for a specific user. These settings would overwrite the GeneralConfig settings for the same sUserConfigID. The settings are written to a respository specific to the user logged in based upon the sUserCongifID strings used to create the UserConfig object. The settings written by a particular module or task are available to any modules/tasks that know the sUserConfigID for the same logged in user. DEV NOTE: Although the methods in this class provide flexibility and increased performance when frequently saving/changing multiple user settings, it is highly recommended that developers use the setPersistentData() and getPersistentData() convenience methods found in the Plugin/Task context (dev.novell.emframe.dev.PluginContext) whenever possible to set persistent perferences. Unless settings are being changed frequently, these convenience methods are much easier to use.

Constructor Summary

Constructors

Constructor and Description
UserConfig(java.lang.String sUserConfigID, MContext ctx) This constructor will create a UserConfig object for the user logged into the current session based upon the sUserConfigID.
UserConfig(java.lang.String sUserConfigID, java.lang.String sObjectDN, MContext ctx) This constructor will create a UserConfig object for the user passed in based upon the sUserConfigID.

Method Summary

Modifier and Type	Method and Description
void	addSettingValue(java.lang.String sName, java.lang.String sValue) Add a String value to the end of the String array of values for a setting.
java.lang.Object	getObjectSetting(java.lang.String sName) Get a setting's first value as a serialized Object.
java.lang.Object[]	getObjectSettings(java.lang.String sName) Get all of a setting's values as a serialized Object array.
java.lang.String	getSetting(java.lang.String sName) Get a setting's first value as a String.
java.lang.String	getSetting(java.lang.String sName, java.lang.String sDefaultValue) Get a setting's first value as a String.
java.lang.String[]	getSettingNames() Get a String array of all setting names available for this sUserConfigID.
java.lang.String[]	getSettings(java.lang.String sName) Get all of a setting's values as a String array.
static UserConfig	getUserConfig(java.lang.String sUserConfigID, MContext ctx) This method will get either a previously created UserConfig object from the session or create a new one for the user currently logged in based upon the sUserConfigID parameter.
static UserConfig	getUserConfig(java.lang.String sUserConfigID, java.lang.String sObjectDN, MContext ctx) This method will get either a previously created UserConfig object from the session or create a new one for the user currently logged in based upon the sUserConfigID parameter.
java.lang.String	getUserConfigFileName() Returns the absolute file name for this user config
void	removeSetting(java.lang.String sName) Removes all setting values from a setting.
void	removeSettingValue(java.lang.String sName, java.lang.String sValue) Remove a String value from the String array of values for a setting.
void	setObjectSetting(java.lang.String sName, java.lang.Object oValue) Set a setting to be a serialized Object value.
void	setObjectSetting(java.lang.String sName, java.lang.Object[] oaValues) Set a setting to be a serialized Object array of values.
void	setSetting(java.lang.String sName, java.lang.String sValue) Set a setting to be a single String value.
void	setSetting(java.lang.String sName, java.lang.String[] saValues) Set a setting to be a String array of values.
void	writeSettings() Writes settings to persistent storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserConfig

public UserConfig(java.lang.String sUserConfigID,
                  MContext ctx)

This constructor will create a UserConfig object for the user logged into the current session based upon the sUserConfigID. A UserConfig object holds all settings with the same sUserConfigID. If sUserConfigID is null or zero length, an unnamed UserConfig is returned.

Parameters:

ctx - Context of the task to determine the currently logged in user

sUserConfigID - Name of the UserConfig object to create or null

UserConfig

public UserConfig(java.lang.String sUserConfigID,
                  java.lang.String sObjectDN,
                  MContext ctx)

This constructor will create a UserConfig object for the user passed in based upon the sUserConfigID. A UserConfig object holds all settings with the same sUserConfigID. If sUserConfigID is null or zero length, an unnamed UserConfig is returned.

Parameters:

ctx - Context of the task to determine the currently logged in user

sUserConfigID - Name of the UserConfig object to create or null

sObjectDN - DN of the object (may be different than the currently logged in user)

See Also:

setPersistentData() and getPersistentData().

Method Detail

getUserConfig

public static UserConfig getUserConfig(java.lang.String sUserConfigID,
                                       MContext ctx)

This method will get either a previously created UserConfig object from the session or create a new one for the user currently logged in based upon the sUserConfigID parameter. A UserConfig object holds all settings that were created using the sUserConfigID. If sUserConfigID is null or zero length, an unnamed UserConfig is returned.

Parameters:

ctx - Context of the task to determine the currently logged in user

sUserConfigID - The name of the UserConfig to retrieve

Returns:

UserConfig A UserConfig object based upon the sUserConfigID for the currently logged in user

See Also:

setPersistentData() and getPersistentData().

getUserConfig

public static UserConfig getUserConfig(java.lang.String sUserConfigID,
                                       java.lang.String sObjectDN,
                                       MContext ctx)

This method will get either a previously created UserConfig object from the session or create a new one for the user currently logged in based upon the sUserConfigID parameter. A UserConfig object holds all settings that were created using the sUserConfigID. If sUserConfigID is null or zero length, an unnamed UserConfig is returned.

Parameters:

ctx - Context of the task to determine the currently logged in user

sUserConfigID - The name of the UserConfig to retrieve

sObjectDN -

Returns:

UserConfig A UserConfig object based upon the sUserConfigID for the currently logged in user

See Also:

setPersistentData() and getPersistentData().

getSettingNames

public java.lang.String[] getSettingNames()

Get a String array of all setting names available for this sUserConfigID.

Returns:

String array of the setting names

getSetting

public java.lang.String getSetting(java.lang.String sName)

Get a setting's first value as a String. If there are multiple values, only the first value is returned.

Parameters:

sName - Name of the setting

Returns:

Value of the setting, null if none found

See Also:

setSetting(String, String)

getSetting

public java.lang.String getSetting(java.lang.String sName,
                                   java.lang.String sDefaultValue)

Get a setting's first value as a String. If there are multiple values, only the first value is returned. If no value is found, sDefaultValue is returned instead.

Parameters:

sName - Name of the setting

sDefaultValue - Value to be returned of no value is found

Returns:

String value of the setting, sDefaultValue is returned if no value found

See Also:

setSetting(String, String)

getObjectSetting

public java.lang.Object getObjectSetting(java.lang.String sName)

Get a setting's first value as a serialized Object. If there are multiple values, only the first value is returned.

Parameters:

sName - Name of the setting

Returns:

Object if found, null if none found

See Also:

setObjectSetting(String, Object)

getSettings

public java.lang.String[] getSettings(java.lang.String sName)

Get all of a setting's values as a String array.

Parameters:

sName - Name of the setting

Returns:

String array of values of the setting, null if none found

See Also:

setSetting(String, String)

getObjectSettings

public java.lang.Object[] getObjectSettings(java.lang.String sName)

Get all of a setting's values as a serialized Object array.

Parameters:

sName - Name of the setting

Returns:

Object array if found, null if none found

See Also:

setObjectSetting(String, Object)

setSetting

public void setSetting(java.lang.String sName,
                       java.lang.String sValue)
                throws ConfigException

Set a setting to be a single String value. All previous values are overwritten. You must call writeSettings after calling this call to have the settings written to persistent storage.

Parameters:

sName - Name of the setting

sValue - Value to set, all other values will be overwritten

Throws:

ConfigException - If the current logged in user is unable to perform the operation

See Also:

getSetting(String), writeSettings()

setObjectSetting

public void setObjectSetting(java.lang.String sName,
                             java.lang.Object oValue)
                      throws ConfigException

Set a setting to be a serialized Object value. All previous values are overwritten. You must call writeSettings after calling this call to have the settings written to persistent storage.

Parameters:

sName - Name of the setting

oValue - Value to set, all other values will be overwritten

Throws:

ConfigException - If the current logged in user is unable to perform the operation

See Also:

getObjectSetting(java.lang.String), writeSettings()

setSetting

public void setSetting(java.lang.String sName,
                       java.lang.String[] saValues)
                throws ConfigException

Set a setting to be a String array of values. All previous values are overwritten. You must call writeSettings after calling this call to have the settings written to persistent storage.

Parameters:

sName - Name of the setting

saValues - Values to be set, all other values will be overwritten

Throws:

ConfigException - If the current logged in user is unable to perform the operation

See Also:

getSettings(java.lang.String), writeSettings()

setObjectSetting

public void setObjectSetting(java.lang.String sName,
                             java.lang.Object[] oaValues)
                      throws ConfigException

Set a setting to be a serialized Object array of values. All previous values are overwritten. You must call writeSettings after calling this call to have the settings written to persistent storage.

Parameters:

sName - Name of the setting

oaValues - Values to be set, all other values will be overwritten

Throws:

ConfigException - If the current logged in user is unable to perform the operation

See Also:

getObjectSettings(java.lang.String), writeSettings()

addSettingValue

public void addSettingValue(java.lang.String sName,
                            java.lang.String sValue)
                     throws ConfigException

Add a String value to the end of the String array of values for a setting. All current values are preserved. You must call writeSettings after calling this call to have the settings written to persistent storage.

Parameters:

sName - Name of the setting

sValue - Value to add to the current values already present

Throws:

ConfigException - If the current logged in user is unable to perform the operation

See Also:

removeSettingValue(java.lang.String, java.lang.String), writeSettings()

removeSettingValue

public void removeSettingValue(java.lang.String sName,
                               java.lang.String sValue)
                        throws ConfigException

Remove a String value from the String array of values for a setting. All other current values are preserved. You must call writeSettings after calling this call to have the settings written to persistent storage.

Parameters:

sName - Name of the setting

sValue - Value to be removed

Throws:

ConfigException - If the current logged in user is unable to perform the operation

See Also:

addSettingValue(java.lang.String, java.lang.String), writeSettings()

removeSetting

public void removeSetting(java.lang.String sName)
                   throws ConfigException

Removes all setting values from a setting. You must call writeSettings after calling this call to have the settings written to persistent storage.

Parameters:

sName - Name of setting

Throws:

ConfigException - If the current logged in user is unable to perform the operation

See Also:

writeSettings()

writeSettings

public void writeSettings()
                   throws ConfigException

Writes settings to persistent storage. You must call writeSettings after calling any of the set or remove calls to have the settings written to persistent storage.

Throws:

ConfigException - If the current logged in user is unable to perform the operation

getUserConfigFileName

public java.lang.String getUserConfigFileName()

Returns the absolute file name for this user config

Returns:

The absolute file name for this user config