com.novell.emframe.dev
Class PluginContext

java.lang.Object
  com.novell.emframe.dev.PluginContext

Direct Known Subclasses:

TaskContext

public class PluginContext

extends java.lang.Object

Passes information to Task objects. TaskContext extends PluginContext, but these objects are basically interchangable. PluginContext is left for backwards compatibility for methods passing a PluginContext.

TaskContext objects are passed in the execute method of Task objects. Task objects can then use the TaskContext object to get information about the HttpServletRequest and about the user who is performing the task.

The main methods to use to access objects your task may need:

• getSession() - Returns the HttpSession object if you need to get attributes off of the session. However, try to use getAttribute, setAttribute, and removeAttribute or getGlobalVar, setGlobalVar, and removeGlobalVar instead. Any attributes put on the session by your task must be manually removed at logout by your task.
• getAttribute(java.lang.Object) or getGlobalVar(java.lang.String) - Use instead of getSession to get attributes off of a session specific cache of key/value pairs that automatically gets cleaned up on logout.
• setAttribute(java.lang.Object, java.lang.Object) or setGlobalVar(java.lang.String, java.lang.String) - Use instead of getSession to set attributes on a session specific cache of key/value pairs that automatically gets cleaned up on logout.
• removeAttribute(java.lang.Object)or removeGlobalVar(java.lang.String) - Use instead of getSession to remove attributes off of a session specific cache of key/value pairs that automatically gets cleaned up on logout.
• getRequest() - Returns the HttpServletRequest object. Use HttpServletRequest.setAttribute() to put key/value pairs on the request so your JSP file can retrieve them using request.getAttribute().
• getAuthenticationBroker() - Returns the AuthenticationBroker object for use in obtaining connections to the directory the user logged into (NDAP or LDAP connections).
• getDirUtils() - Returns the DirUtils object, which provides utility methods for accessing the directory.
• getLocale() - Returns the Locale object to use for any localization of your task.
• getDeviceType() - Returns the current device used by the user (browser, mozilla, default, pocket).

Field Summary

protected iMgrAuthenticator	authenticator Holds the current iMgrAuthenticator.
protected com.novell.nps.gadgetManager.BaseGadgetInstance	baseGadgetInstance Handle to the BaseGadgetInstance implementation of the task.
protected static java.lang.String	contextPath String used to hold the context path of the servlet.
protected javax.servlet.http.HttpServletRequest	httpServletRequest Holds the current HttpServletRequest.
protected javax.servlet.http.HttpServletResponse	httpServletResponse Holds the current HttpServletResponse.
protected com.novell.webaccess.common.I18NLocale	i18nLocale Holds the I18NLocale wrapper object used to hold the current Locale.
protected com.novell.webaccess.common.I18NServletRequest	i18nServletRequest Holds the I18ServletRequest wrapper object used to hold the current request.
protected ManagementServiceSet	manageSS Holds the current ManagementServiceSet.
protected java.util.Properties	resultStrings Properties object where the name/values pairs generated by the task are stored.
protected com.novell.nps.sessionManager.PortalSession	session Holds the current PortalSession wrapper around the HttpSession.

Constructor Summary

PluginContext(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
Constructs a PluginContext with the current HttpServletRequest and HttpServletResponse.

Method Summary

void	addToHistory(ObjectEntry oe) Add a directory object represented by ObjectEntry to the user's history list for later selection.
void	addToHistory(java.lang.String objectTypeName, java.lang.String objectName) Add a directory object represented by the object's type name (class) and the FDN of the object to the user's history list for later selection.
void	clearHistory() Clears all objects from the user's history list.
org.w3c.dom.Document	createDocument(java.lang.String rootTagName) Deprecated. As of iManager 2.5, convert BaseGadgetInstance calls to Task
java.lang.Object	getAttribute(java.lang.Object attrKey) Returns the value to which the specified attribute key is associated with.
AuthenticationBroker	getAuthenticationBroker() Returns the AuthenticationBroker associated with this logged in user.
iMgrAuthenticator	getAuthenticator() Returns the iMgrAuthenticator object associated with this PluginContext.
com.novell.nps.gadgetManager.BaseGadgetInstance	getBaseGadgetInstance() Deprecated. As of iManager 2.5. Will be removed at future date.
com.novell.webaccess.common.I18NLocale	getBrowserLocale() Deprecated. As of iManager 2.5, use getLocale instead. Will be removed at a later date.
java.lang.String	getClientLocal() Returns the list of Locales in a String that are "," delimited.
java.lang.String	getContextPath() Returns the context path from the HttpServletRequest.
java.lang.String	getDeviceType() Returns the current device type.
DirUtils	getDirUtils() Returns the DirUtils object which contains utility methods for accessing the directory.
org.w3c.dom.Document	getDocument() Deprecated. As of iManager 2.5, convert BaseGadgetInstance calls to Task
java.util.Properties	geteMFrameConfigProperties() Deprecated. As of iManager 2.5, use com.novell.emframe.dev.config.SystemConfig instead
java.lang.String	getGlobalVar(java.lang.String varName) Returns the value to which the specified attribute key is associated with.
HistoryNode[]	getHistory(java.lang.String[] objectTypeNames) Returns an array of HistoryNode objects containing all objects in the user's history that match any of the object types (classes) passed in.
com.novell.webaccess.common.I18NServletRequest	getHttpServletRequest() Deprecated. As of iManager 2.5, use getRequest instead. Will be removed at a later date.
Task	getLiveTask(java.lang.String taskId) Returns a Task class pointing to an instantiated class for the taskId passed in.
java.util.Locale	getLocale() Returns the Locale for use in localization.
ManagementServiceSet	getManagementServiceSet() Deprecated. As of iManager 2.5, use getAuthenticator.
java.lang.String	getModulesPath() Returns the path to the modules directory for use in JSPs referencing images or other files under their module directory.
java.util.Properties	getProviderProperties() Deprecated. As of iManager 2.5, use SystemConfig instead.
javax.servlet.http.HttpServletRequest	getRequest() Returns the current HttpServletRequest object for use by Tasks.
javax.servlet.http.HttpServletResponse	getResponse() Returns the current HttpServletResponse associated with the HttpServletRequest.
java.util.Properties	getResultStrings() Deprecated. As of iManager 2.5, in Task.execute( TaskContext context, Properties resultStrings ) instead of putting the key/value pairs in the Properties object, simply put them as attributes on the HttpServletRequest object.
javax.servlet.http.HttpSession	getSession() Returns the HttpSession object for retrieval of information.
java.util.Hashtable	getSessionCache() Deprecated. As of iManager 2.5, use getAttribute, setAttribute, removeAttribute.
com.novell.emframe.fw.ServiceSyncLock	getSynchLock() Returns the ServiceSyncLock used to synchronize access to make this Task thread safe.
java.lang.String	getTaskId() Returns the unique TaskID for this task.
UserConfig	getUserConfig() Returns the UserConfig object from the session or creates one if not already present.
java.io.File	getWebappHome() Returns a File pointing to the root of webapps.
void	init(javax.servlet.http.HttpServletRequest req, com.novell.nps.gadgetManager.BaseGadgetInstance baseGadgetInstance) Initialize the PluginContext with the HttpServletRequest and a BaseGadgetInstance handle to the task.
void	init(com.novell.webaccess.common.I18NServletRequest i18nReq, javax.servlet.http.HttpServletRequest req, com.novell.nps.gadgetManager.BaseGadgetInstance baseGadgetInstance) Initialize the PluginContext with an I18NServletReqest as well as the HttpServletRequest and a BaseGadgetInstance handle to the task.
boolean	isTaskAvailable(java.lang.String taskId) Checks to see if a Task with the specified unique ID is available to be run.
boolean	isXml() Deprecated. As of iManager 2.5, convert XML/XSL Tasks to JSP
void	makeLike(PluginContext context) Make the current PluginContext contain the same member variables as the passed in PluginContext.
void	removeAttribute(java.lang.Object attrKey) Removes the attribute key and associated value if present.
void	removeFromHistory(java.lang.String objectName) Removes a directory object from the user's history list based upon the FDN of the object.
void	removeGlobalVar(java.lang.String varName) Removes the attribute key and associated value if present.
void	setAttribute(java.lang.Object attrKey, java.lang.Object attrValue) Saves the specified attribute value with the specified attribute key.
void	setGlobalVar(java.lang.String varName, java.lang.String val) Saves the specified attribute value with the specified attribute key.
boolean	storeeMFrameConfigProperty(java.lang.String header, java.lang.String key, java.lang.String value, boolean evalAndUse) Deprecated. As of iManager 2.5, use SystemConfig or GeneralConfig.

Methods inherited from class java.lang.Object

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

Field Detail

authenticator

protected iMgrAuthenticator authenticator

Holds the current iMgrAuthenticator.

baseGadgetInstance

protected com.novell.nps.gadgetManager.BaseGadgetInstance baseGadgetInstance

Handle to the BaseGadgetInstance implementation of the task.

contextPath

protected static java.lang.String contextPath

String used to hold the context path of the servlet.

httpServletRequest

protected javax.servlet.http.HttpServletRequest httpServletRequest

Holds the current HttpServletRequest.

httpServletResponse

protected javax.servlet.http.HttpServletResponse httpServletResponse

Holds the current HttpServletResponse.

i18nLocale

protected com.novell.webaccess.common.I18NLocale i18nLocale

Holds the I18NLocale wrapper object used to hold the current Locale.

i18nServletRequest

protected com.novell.webaccess.common.I18NServletRequest i18nServletRequest

Holds the I18ServletRequest wrapper object used to hold the current request.

manageSS

protected ManagementServiceSet manageSS

Holds the current ManagementServiceSet.

resultStrings

protected java.util.Properties resultStrings

Properties object where the name/values pairs generated by the task are stored.

session

protected com.novell.nps.sessionManager.PortalSession session

Holds the current PortalSession wrapper around the HttpSession.

Constructor Detail

PluginContext

public PluginContext(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse resp)

Constructs a PluginContext with the current HttpServletRequest and HttpServletResponse. From this, the PluginContext can get the HttpSession and ManagementServiceSet. Tasks should not have to construct a PluginContext, but are passed an already created and initialized PluginContext.

Parameters:

req - The current HttpServletRequest

resp - The current HttpServletResponse

Method Detail

addToHistory

public void addToHistory(ObjectEntry oe)

Add a directory object represented by ObjectEntry to the user's history list for later selection. Tasks must manually add objects to the history list once a user has done something to that object once (create, edit, delete).

Parameters:

oe - ObjectEntry representing the directory object

addToHistory

public void addToHistory(java.lang.String objectTypeName,
                         java.lang.String objectName)

Add a directory object represented by the object's type name (class) and the FDN of the object to the user's history list for later selection. Tasks must manually add objects to the history list once a user has done something to that object once (create, edit, delete).

Parameters:

objectTypeName - String containing the type or class name of the object

objectName - String containing the full distinguished name (FDN) of the object

clearHistory

public void clearHistory()

Clears all objects from the user's history list.

createDocument

public org.w3c.dom.Document createDocument(java.lang.String rootTagName)

Deprecated. As of iManager 2.5, convert BaseGadgetInstance calls to Task

Creates an empty Document for use in the default document support. Not needed if you extend the Task class instead of BaseGadgetInstance.

Parameters:

rootTagName - String containing the root XML element name

Returns:

XML Document for use in BaseGadgetInstance calls

getAttribute

public java.lang.Object getAttribute(java.lang.Object attrKey)

Returns the value to which the specified attribute key is associated with. If no associated key is found, then null will be returned. Attribute keys should be prefixed with the module id to avoid collisions. The cache of key/value pairs is specific to the logged in directory. When the user logs out the key/value pairs are discarded. This is the same as getGlobalVar, except this call takes any Object instead of just Strings.

Use instead of getSession to get attributes off of a session specific cache of key/value pairs that automatically gets cleaned up on logout.

Parameters:

attrKey - Object containing the attribute key whose associated value is to be returned This may not be null.

Returns:

Object value associated with key or null if no attribute key was found

See Also:

setAttribute(java.lang.Object, java.lang.Object), getGlobalVar(java.lang.String)

getAuthenticationBroker

public AuthenticationBroker getAuthenticationBroker()

Returns the AuthenticationBroker associated with this logged in user. Returns the AuthenticationBroker object for use in obtaining connections to the directory the user logged into (NDAP or LDAP connections).

Returns:

AuthenticationBroker associated with this logged in user

getAuthenticator

public iMgrAuthenticator getAuthenticator()

Returns the iMgrAuthenticator object associated with this PluginContext. The iMgrAuthenticator object contains all necessary authentication information.

Returns:

iMgrAuthenticator object

getBaseGadgetInstance

public com.novell.nps.gadgetManager.BaseGadgetInstance getBaseGadgetInstance()

Deprecated. As of iManager 2.5. Will be removed at future date.

Returns the BaseGadgetInstance object of the task using this PluginContext. The Task class extends BaseGadgetInstance for backwards compatibility.

Returns:

BaseGadgetInstance object

getBrowserLocale

public com.novell.webaccess.common.I18NLocale getBrowserLocale()

Deprecated. As of iManager 2.5, use getLocale instead. Will be removed at a later date.

Returns the I18NLocale wrapper around the browser's Locale object.

Returns:

I18NLocale wrapper around the browser's Locale object

See Also:

getLocale()

getClientLocal

public java.lang.String getClientLocal()

Returns the list of Locales in a String that are "," delimited. If you have specified in your browser the locales "en-us", "fr", and "es-us", this would return "en-US,fr-;1.0,es-US;1.0".

Returns:

String containing all Locales specified that are "," delimited

getContextPath

public java.lang.String getContextPath()

Returns the context path from the HttpServletRequest. Usually this returns "/nps" unless the web application name is changed. Don't hardcode "/nps" in your Tasks, instead use the getContextPath() call to return the web application name because it might change.

Returns:

String containing the context path (ie. "/nps")

getDeviceType

public java.lang.String getDeviceType()

Returns the current device type.

The following table lists the possible return values and their meanings:

Return Value	Meaning
browser	Internet Explorer
mozilla	Netscape or Mozilla-based browsers
default	All other browsers
pocket	PDA devices such as Palm Pilot and Windows CE devices

Returns:

String containing the current device type

getDirUtils

public DirUtils getDirUtils()

Returns the DirUtils object which contains utility methods for accessing the directory.

Returns:

DirUtils object for directory methods

getDocument

public org.w3c.dom.Document getDocument()

Deprecated. As of iManager 2.5, convert BaseGadgetInstance calls to Task

Gets an internally managed document for the data of the task. If one does not already exist it is created. Not needed if you extend the Task class instead of BaseGadgetInstance.

Returns:

XML Document for use in BaseGadgetInstance calls

geteMFrameConfigProperties

public java.util.Properties geteMFrameConfigProperties()

Deprecated. As of iManager 2.5, use com.novell.emframe.dev.config.SystemConfig instead

Returns the server configuration information in a Properties object. Only here for backwards compatibility. Instead use com.novell.emframe.dev.config.SystemConfig to read and write system-wide configuration settings.

Returns:

Properties object to read configuration key/value settings

See Also:

SystemConfig

getGlobalVar

public java.lang.String getGlobalVar(java.lang.String varName)

Returns the value to which the specified attribute key is associated with. If no associated key is found, then null will be returned. Attribute keys should be prefixed with the module id to avoid collisions. The cache of key/value pairs is specific to the logged in directory. When the user logs out the key/value pairs are discarded. This is the same as getAttribute, but this call only accepts Strings.

Use instead of getSession to get attributes off of a session specific cache of key/value pairs that automatically gets cleaned up on logout.

Parameters:

varName - String containing the attribute key whose associated value is to be returned This may not be null.

Returns:

String value associated with key or null if no attribute key was found

See Also:

getAttribute(java.lang.Object), setGlobalVar(java.lang.String, java.lang.String)

getHistory

public HistoryNode[] getHistory(java.lang.String[] objectTypeNames)

Returns an array of HistoryNode objects containing all objects in the user's history that match any of the object types (classes) passed in.

Parameters:

objectTypeNames - String array of object types (classes) to retrieve history for

Returns:

HistoryNode array containing all objects in the user's history matching the object types

getHttpServletRequest

public com.novell.webaccess.common.I18NServletRequest getHttpServletRequest()

Deprecated. As of iManager 2.5, use getRequest instead. Will be removed at a later date.

Returns the I18NServletRequest wrapper around the HttpServletRequest.

Returns:

I18NServletRequest wrapper around the HttpServletRequest

See Also:

getRequest()

getLiveTask

public Task getLiveTask(java.lang.String taskId)

Returns a Task class pointing to an instantiated class for the taskId passed in. You can use the Task class to make calls on the returned Task.

Parameters:

taskId - String containing the unique ID of the task

Returns:

Task class pointing to an instantiated class

getLocale

public java.util.Locale getLocale()

Returns the Locale for use in localization. May or may not be the same as the Locale for the HttpServletRequest.

Returns:

Locale object for use in the Task

getManagementServiceSet

public ManagementServiceSet getManagementServiceSet()

Deprecated. As of iManager 2.5, use getAuthenticator.

Returns the ManagementServiceSet object associated with this PluginContext. The ManagementServiceSet object contains all necessary authentication information and is an iMgrAuthenticator. Going forward, Tasks should get data from their iMgrAuthenticator instead of hard coding to the ManagementServiceSet.

Returns:

ManagementServiceSet object

See Also:

getAuthenticator()

getModulesPath

public java.lang.String getModulesPath()

Returns the path to the modules directory for use in JSPs referencing images or other files under their module directory. Usually this returns "/nps/portal/modules" unless the web application name is changed. Don't hardcode "/nps" anywhere in your Tasks, instead use the getContextPath() call to get the web application name because it might change.

Returns:

String containing the path to the modules directory, including the context path (ie. "/nps/portal/modules")

See Also:

getContextPath()

getProviderProperties

public java.util.Properties getProviderProperties()

Deprecated. As of iManager 2.5, use SystemConfig instead.

Returns the iManager configuration information in a Properties object containing system-wide configuration key/value pairs.

Returns:

Properties object containing system-wide configuration key/value pairs

See Also:

SystemConfig

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns the current HttpServletRequest object for use by Tasks. Use HttpServletRequest.setAttribute() to put key/value pairs on the request so your JSP file can retrieve them using request.getAttribute().

Returns:

The current HttpServletRequest

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Returns the current HttpServletResponse associated with the HttpServletRequest.

Returns:

The current HttpServletResponse associated with the HttpServletRequest

getResultStrings

public java.util.Properties getResultStrings()

Deprecated. As of iManager 2.5, in Task.execute( TaskContext context, Properties resultStrings ) instead of putting the key/value pairs in the Properties object, simply put them as attributes on the HttpServletRequest object.

Returns the Properties object where key/value pairs of the task are stored and placed on the HttpServletRequest.

Returns:

The properties object where the key/values pairs generated by the task are stored

getSession

public javax.servlet.http.HttpSession getSession()

Returns the HttpSession object for retrieval of information. However, try to use getAttribute, setAttribute, and removeAttribute or getGlobalVar, setGlobalVar, and removeGlobalVar instead. Any attributes put on the session by your task must be manually removed at logout by your task.

Returns:

HttpSession object

See Also:

getAttribute(java.lang.Object), setAttribute(java.lang.Object, java.lang.Object), removeAttribute(java.lang.Object), getGlobalVar(java.lang.String), setGlobalVar(java.lang.String, java.lang.String), removeGlobalVar(java.lang.String)

getSessionCache

public java.util.Hashtable getSessionCache()

Deprecated. As of iManager 2.5, use getAttribute, setAttribute, removeAttribute.

Gets a Hashtable for storing any key/value pair data. This cache is specific to the logged in eDirectory tree. When the user logs out the hashtable is discarded.

Returns:

Hashtable for storing key/value pair data.

See Also:

getAttribute(java.lang.Object), setAttribute(java.lang.Object, java.lang.Object), removeAttribute(java.lang.Object)

getSynchLock

public com.novell.emframe.fw.ServiceSyncLock getSynchLock()

Returns the ServiceSyncLock used to synchronize access to make this Task thread safe.

Returns:

ServiceSyncLock object to synchronize access to this task

getTaskId

public java.lang.String getTaskId()

Returns the unique TaskID for this task. The TaskID may or may not be the same as the ID used to register this task with iManager in the tasks XML Descriptor depending upon how the task was instantiated.

Returns:

String containing the unique TaskID for this task

getUserConfig

public UserConfig getUserConfig()

Returns the UserConfig object from the session or creates one if not already present. UserConfig can be used to read and write Task specific information for the current user.

Returns:

UserConfig object to read and write Task specific information for the current user

getWebappHome

public java.io.File getWebappHome()

Returns a File pointing to the root of webapps.

Returns:

File pointing to the root of webapps

init

public void init(javax.servlet.http.HttpServletRequest req,
                 com.novell.nps.gadgetManager.BaseGadgetInstance baseGadgetInstance)

Initialize the PluginContext with the HttpServletRequest and a BaseGadgetInstance handle to the task. The Task class extends BaseGadgetInstance for backwards compatibility. Tasks should not have to construct a PluginContext, but are passed an already created and initialized PluginContext.

Parameters:

req - The current HttpServletRequest

baseGadgetInstance - BaseGadgetInstance handle to the task

init

public void init(com.novell.webaccess.common.I18NServletRequest i18nReq,
                 javax.servlet.http.HttpServletRequest req,
                 com.novell.nps.gadgetManager.BaseGadgetInstance baseGadgetInstance)

Initialize the PluginContext with an I18NServletReqest as well as the HttpServletRequest and a BaseGadgetInstance handle to the task. The Task class extends BaseGadgetInstance for backwards compatibility.

Parameters:

i18nReq - The current HttpServletRequest wrapped in an I18NServletRequest object

req - The current HttpServletRequest

baseGadgetInstance - BaseGadgetInstance handle to the task

isTaskAvailable

public boolean isTaskAvailable(java.lang.String taskId)

Checks to see if a Task with the specified unique ID is available to be run. Things that might make a Task unavailable are if the Task cannot run on the current device or operating system.

Parameters:

taskId - String containing the unique ID of the Task

Returns:

boolean: true if the Task is available to run, false if otherwise

isXml

public boolean isXml()

Deprecated. As of iManager 2.5, convert XML/XSL Tasks to JSP

Returns whether the Task is an XML/XSL Task. Not needed if you extend the Task class instead of BaseGadgetInstance and use JSPs instead of XSL.

Returns:

boolean: true if Task uses XML/XSL, false if otherwise

makeLike

public void makeLike(PluginContext context)

Make the current PluginContext contain the same member variables as the passed in PluginContext. Similar to a clone() method but the member variables point at the original instead of being clones.

Parameters:

context - PluginContext to clone

removeAttribute

public void removeAttribute(java.lang.Object attrKey)

Removes the attribute key and associated value if present. Attribute keys should be prefixed with the module id to avoid collisions. The cache of key/value pairs is specific to the logged in directory. When the user logs out the key/value pairs are discarded. This is the same as removeGlobalVar, except this call takes any Object instead of just Strings.

Use instead of getSession to remove attributes off of a session specific cache of key/value pairs that automatically gets cleaned up on logout.

Parameters:

attrKey - Object containing the attribute key whose associated value is to be removed This may not be null.

See Also:

removeGlobalVar(java.lang.String)

removeFromHistory

public void removeFromHistory(java.lang.String objectName)

Removes a directory object from the user's history list based upon the FDN of the object.

Parameters:

objectName - String containing the full distinguished name (FDN) of the object

removeGlobalVar

public void removeGlobalVar(java.lang.String varName)

Removes the attribute key and associated value if present. Attribute keys should be prefixed with the module id to avoid collisions. The cache of key/value pairs is specific to the logged in directory. When the user logs out the key/value pairs are discarded. This is the same as removeAttribute, but this call only accepts Strings.

Use instead of getSession to remove attributes off of a session specific cache of key/value pairs that automatically gets cleaned up on logout.

Parameters:

varName - String containing the attribute key whose associated value is to be removed This may not be null.

See Also:

removeGlobalVar(java.lang.String)

setAttribute

public void setAttribute(java.lang.Object attrKey,
                         java.lang.Object attrValue)

Saves the specified attribute value with the specified attribute key. If a previous value for this attribute key existed, it will be overwritten. Attribute keys should be prefixed with the module id to avoid collisions. The cache of key/value pairs is specific to the logged in directory. When the user logs out the key/value pairs are discarded. This is the same as setGlobalVar, except this call takes any Object instead of just Strings.

Use instead of getSession to set attributes on a session specific cache of key/value pairs that automatically gets cleaned up on logout.

Parameters:

attrKey - Object containing the attribute key whose associated value is to be set This may not be null.

attrValue - Object value to be saved. This may not be null.

See Also:

getAttribute(java.lang.Object), setGlobalVar(java.lang.String, java.lang.String)

setGlobalVar

public void setGlobalVar(java.lang.String varName,
                         java.lang.String val)

Saves the specified attribute value with the specified attribute key. If a previous value for this attribute key existed, it will be overwritten. Attribute keys should be prefixed with the module id to avoid collisions. The cache of key/value pairs is specific to the logged in directory. When the user logs out the key/value pairs are discarded. This is the same as setAttribute, but this call only accepts Strings.

Use instead of getSession to set attributes on a session specific cache of key/value pairs that automatically gets cleaned up on logout.

Parameters:

varName - String containing the attribute key whose associated value is to be set This may not be null.

val - String value to be saved. This may not be null.

See Also:

setAttribute(java.lang.Object, java.lang.Object), getGlobalVar(java.lang.String)

storeeMFrameConfigProperty

public boolean storeeMFrameConfigProperty(java.lang.String header,
                                          java.lang.String key,
                                          java.lang.String value,
                                          boolean evalAndUse)

Deprecated. As of iManager 2.5, use SystemConfig or GeneralConfig.

Stores system-wide configuration key/value pairs. Currently, this function does nothing.

Parameters:

header - String currently not used

key - String currently not used

value - String currently not used

evalAndUse - boolean currently not used

Returns:

boolean: always returns true

See Also:

SystemConfig, GeneralConfig