com.novell.emframe.dev

Interface PluginContext

All Superinterfaces:

MContext

All Known Subinterfaces:

PropertyPageContext, TaskContext

Deprecated.

use TaskContext

public interface PluginContext
extends MContext

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.
• getAuthAttribute(Object) - Use instead of getSession to get attributes off of a session specific cache of key/value pairs that automatically gets cleaned up on logout.
• setAuthAttribute(Object, Object) - Use instead of getSession to set attributes on a session specific cache of key/value pairs that automatically gets cleaned up on logout.
• removeAuthAttribute(Object) - 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).

See Also:

TaskContext

Method Summary

Modifier and Type	Method and Description
void	addToHistory(ObjectEntry oe) Deprecated. 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) Deprecated. 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() Deprecated. 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) Deprecated. as of 2.6 getAuthAttribute(Object)
java.lang.Object	getAuthAttribute(java.lang.Object attrKey) Deprecated. Returns the value to which the specified attribute key is associated with from the default authenticators context.
AuthenticationBroker	getAuthenticationBroker() Deprecated. Returns the AuthenticationBroker associated with this logged in user.
iMgrAuthenticator	getAuthenticator() Deprecated. 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() Deprecated. as of 2.6 use #getLocale(HttpSession)
java.lang.String	getContextPath() Deprecated. Returns the context path from the HttpServletRequest.
java.lang.String	getDeviceType() Deprecated. Returns the current device type.
DirUtils	getDirUtils() Deprecated. 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) Deprecated.
HistoryNode[]	getHistory(java.lang.String[] objectTypeNames) Deprecated. as of 2.6 this functionallity is no longer exposed.
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) Deprecated. as of 2.6 instead the task should pass any anformation needed on the request.
java.util.Locale	getLocale() Deprecated. Returns the Locale for use in localization.
ManagementServiceSet	getManagementServiceSet() Deprecated. As of iManager 2.5, use ManagementServiceSet.getManagementServiceSet(HttpSession)
java.lang.String	getModulesPath() Deprecated. Returns the path to the modules directory for use in JSPs referencing images or other files under their module directory.
java.lang.String	getPersistentData(java.lang.String configID, java.lang.String keyId) Deprecated. Reads data from the configID UserConfig persistent store.
java.util.Properties	getProviderProperties() Deprecated. As of iManager 2.5, use SystemConfig instead.
javax.servlet.http.HttpServletRequest	getRequest() Deprecated. Returns the current HttpServletRequest object for use by Tasks.
javax.servlet.http.HttpServletResponse	getResponse() Deprecated.
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() Deprecated. Returns the HttpSession object for retrieval of information.
java.util.Hashtable	getSessionCache() Deprecated. As of iManager 2.5, use getAttribute, setAttribute, removeAttribute.
java.lang.String	getTaskId() Deprecated. Returns the unique TaskID for this task.
java.io.File	getWebappHome() Deprecated. Returns a File pointing to the root of webapps.
boolean	isDisconnected() Deprecated.
boolean	isTaskAvailable(java.lang.String taskId) Deprecated. Checks to see if a Task with the specified unique ID is available to be run.
void	removeAttribute(java.lang.Object attrKey) Deprecated. Removes the attribute key and associated value if present.
void	removeAuthAttribute(java.lang.Object attrKey) Deprecated. Removes the attribute key and associated value if present from the default authenticators context.
void	removeFromHistory(java.lang.String objectName) Deprecated. Removes a directory object from the user's history list based upon the FDN of the object.
void	removeGlobalVar(java.lang.String varName) Deprecated. as of 2.0 use TaskContext.setAuthAttribute()
void	setAttribute(java.lang.Object attrKey, java.lang.Object attrValue) Deprecated. Saves the specified attribute value with the specified attribute key.
void	setAuthAttribute(java.lang.Object attrKey, java.lang.Object attrValue) Deprecated. Saves the specified attribute value with the specified attribute key in the default authenticators context.
void	setGlobalVar(java.lang.String varName, java.lang.String val) Deprecated.
void	setPersistentData(java.lang.String configID, java.lang.String keyId, java.lang.String data) Deprecated. Saves the data for the specified key in the configID UserConfig persistent store.
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.

Method Detail

getBaseGadgetInstance

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

getManagementServiceSet

ManagementServiceSet getManagementServiceSet()

Deprecated. As of iManager 2.5, use ManagementServiceSet.getManagementServiceSet(HttpSession)

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:

ManagementServiceSet.getManagementServiceSet(HttpSession)

getAuthenticator

iMgrAuthenticator getAuthenticator()

Deprecated.

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

Specified by:

getAuthenticator in interface MContext

Returns:

iMgrAuthenticator object

getResultStrings

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

storeeMFrameConfigProperty

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

getSessionCache

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)

getAttribute

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

Deprecated. as of 2.6 getAuthAttribute(Object)

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:

setAuthAttribute(Object, Object)

getAuthAttribute

java.lang.Object getAuthAttribute(java.lang.Object attrKey)

Deprecated.

Returns the value to which the specified attribute key is associated with from the default authenticators context. 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.

Specified by:

getAuthAttribute in interface MContext

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)

setAttribute

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

Deprecated.

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)

setAuthAttribute

void setAuthAttribute(java.lang.Object attrKey,
                      java.lang.Object attrValue)

Deprecated.

Saves the specified attribute value with the specified attribute key in the default authenticators context. 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.

Specified by:

setAuthAttribute in interface MContext

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)

removeAttribute

void removeAttribute(java.lang.Object attrKey)

Deprecated.

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)

removeAuthAttribute

void removeAuthAttribute(java.lang.Object attrKey)

Deprecated.

Removes the attribute key and associated value if present from the default authenticators context. 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.

Specified by:

removeAuthAttribute in interface MContext

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)

getHttpServletRequest

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()

getBrowserLocale

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()

getLocale

java.util.Locale getLocale()

Deprecated.

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

Specified by:

getLocale in interface MContext

Returns:

Locale object for use in the Task

getWebappHome

java.io.File getWebappHome()

Deprecated.

Returns a File pointing to the root of webapps.

Specified by:

getWebappHome in interface MContext

Returns:

File pointing to the root of webapps

addToHistory

void addToHistory(ObjectEntry oe)

Deprecated.

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).

Specified by:

addToHistory in interface MContext

Parameters:

oe - ObjectEntry representing the directory object

addToHistory

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

Deprecated.

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).

Specified by:

addToHistory in interface MContext

Parameters:

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

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

removeFromHistory

void removeFromHistory(java.lang.String objectName)

Deprecated.

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

Specified by:

removeFromHistory in interface MContext

Parameters:

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

clearHistory

void clearHistory()

Deprecated.

Clears all objects from the user's history list.

Specified by:

clearHistory in interface MContext

getHistory

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

Deprecated. as of 2.6 this functionallity is no longer exposed.

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

Specified by:

getHistory in interface MContext

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

isTaskAvailable

boolean isTaskAvailable(java.lang.String taskId)

Deprecated.

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.

Specified by:

isTaskAvailable in interface MContext

Parameters:

taskId - String containing the unique ID of the Task

Returns:

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

getRequest

javax.servlet.http.HttpServletRequest getRequest()

Deprecated.

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().

Specified by:

getRequest in interface MContext

Returns:

The current HttpServletRequest

getResponse

javax.servlet.http.HttpServletResponse getResponse()

Deprecated.

getDirUtils

DirUtils getDirUtils()

Deprecated.

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

Specified by:

getDirUtils in interface MContext

Returns:

DirUtils object for directory methods

getGlobalVar

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

Deprecated.

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)

setGlobalVar

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

Deprecated.

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)

removeGlobalVar

void removeGlobalVar(java.lang.String varName)

Deprecated. as of 2.0 use TaskContext.setAuthAttribute()

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)

getAuthenticationBroker

AuthenticationBroker getAuthenticationBroker()

Deprecated.

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).

Specified by:

getAuthenticationBroker in interface MContext

Returns:

AuthenticationBroker associated with this logged in user

isDisconnected

boolean isDisconnected()

Deprecated.

This call will return true or false if in disconnected mode. As of right now, disconnected means that you are running in the LDAP data store and logged into that data store as the primary user.

Returns:

boolean: true if disconnected, false if not

getDeviceType

java.lang.String getDeviceType()

Deprecated.

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

Specified by:

getDeviceType in interface MContext

Returns:

String containing the current device type

getClientLocal

java.lang.String getClientLocal()

Deprecated. as of 2.6 use #getLocale(HttpSession)

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

java.lang.String getContextPath()

Deprecated.

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.

Specified by:

getContextPath in interface MContext

Returns:

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

getModulesPath

java.lang.String getModulesPath()

Deprecated.

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.

Specified by:

getModulesPath in interface MContext

Returns:

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

See Also:

getContextPath()

geteMFrameConfigProperties

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

getProviderProperties

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

getSession

javax.servlet.http.HttpSession getSession()

Deprecated.

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.

Specified by:

getSession in interface MContext

Returns:

HttpSession object

See Also:

getAuthAttribute(java.lang.Object), setAuthAttribute(java.lang.Object, java.lang.Object), removeAuthAttribute(java.lang.Object)

getTaskId

java.lang.String getTaskId()

Deprecated.

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.

Specified by:

getTaskId in interface MContext

Returns:

String containing the unique TaskID for this task

createDocument

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

getDocument

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

getLiveTask

Task getLiveTask(java.lang.String taskId)

Deprecated. as of 2.6 instead the task should pass any anformation needed on the request.

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.

Specified by:

getLiveTask in interface MContext

Parameters:

taskId - String containing the unique ID of the task

Returns:

Task class pointing to an instantiated class

setPersistentData

void setPersistentData(java.lang.String configID,
                       java.lang.String keyId,
                       java.lang.String data)

Deprecated.

Saves the data for the specified key in the configID UserConfig persistent store.

Specified by:

setPersistentData in interface MContext

Parameters:

configID - Name of the UserConfig store to put data in. If null, :: is used.

keyId - String containing the key name of the data

data - String containing the value data

See Also:

getPersistentData(java.lang.String, java.lang.String)

getPersistentData

java.lang.String getPersistentData(java.lang.String configID,
                                   java.lang.String keyId)

Deprecated.

Reads data from the configID UserConfig persistent store. Implements sesssion caching so reads do not need to read directly from the data store.

Specified by:

getPersistentData in interface MContext

Parameters:

configID - Name of the UserConfig store to retreive data from from. If null, :: is used.

keyId - String containing the key name of the data

Returns:

String containing the value data

See Also:

setPersistentData(java.lang.String, java.lang.String, java.lang.String)