com.novell.emframe.dev

Interface TaskContext

All Superinterfaces:

MContext, PluginContext

All Known Subinterfaces:

PropertyPageContext

public interface TaskContext
extends PluginContext

Passes information to Task objects.

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.

Method Summary

Modifier and Type	Method and Description
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 objectName) Add a directory object represented by the object's FDN of the object 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.
java.lang.Object	getAuthAttribute(java.lang.Object attrKey) Returns the value to which the specified attribute key is associated with from the default authenticators context.
AuthenticationBroker	getAuthenticationBroker() Returns the AuthenticationBroker associated with this logged in user.
iMgrAuthenticator	getAuthenticator() Returns the iMgrAuthenticator object associated with this PluginContext.
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.
java.util.Locale	getLocale() Returns the Locale for use in localization.
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.lang.String	getPersistentData(java.lang.String configID, java.lang.String keyId) Reads data from the configID UserConfig persistent store.
javax.servlet.http.HttpServletRequest	getRequest() Returns the current HttpServletRequest object for use by Tasks.
javax.servlet.http.HttpSession	getSession() Returns the HttpSession object for retrieval of information.
java.lang.String	getTaskId() Returns the unique TaskID for this task.
java.io.File	getWebappHome() Returns a File pointing to the root of webapps.
boolean	isTaskAvailable(java.lang.String taskId) Checks to see if a Task with the specified unique ID is available to be run.
void	removeAuthAttribute(java.lang.Object attrKey) Removes the attribute key and associated value if present from the default authenticators context.
void	removeFromHistory(java.lang.String objectName) Removes a directory object from the user's history list based upon the FDN of the object.
void	setAuthAttribute(java.lang.Object attrKey, java.lang.Object attrValue) Saves the specified attribute value with the specified attribute key in the default authenticators context.
void	setPersistentData(java.lang.String configID, java.lang.String keyId, java.lang.String data) Saves the data for the specified key in the configID UserConfig persistent store.

Methods inherited from interface com.novell.emframe.dev.PluginContext

createDocument, getAttribute, getBaseGadgetInstance, getBrowserLocale, getClientLocal, getDocument, geteMFrameConfigProperties, getGlobalVar, getHistory, getHttpServletRequest, getLiveTask, getManagementServiceSet, getProviderProperties, getResponse, getResultStrings, getSessionCache, isDisconnected, removeAttribute, removeGlobalVar, setAttribute, setGlobalVar, storeeMFrameConfigProperty

Method Detail

addToHistory

void addToHistory(ObjectEntry oe)

Description copied from interface: PluginContext

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

Specified by:

addToHistory in interface PluginContext

Parameters:

oe - ObjectEntry representing the directory object

addToHistory

void addToHistory(java.lang.String objectName)

Add a directory object represented by the object's 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:

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

Since:

2.6

addToHistory

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

Description copied from interface: PluginContext

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

Specified by:

addToHistory in interface PluginContext

Parameters:

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

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

clearHistory

void clearHistory()

Description copied from interface: PluginContext

Clears all objects from the user's history list.

Specified by:

clearHistory in interface MContext

Specified by:

clearHistory in interface PluginContext

getAuthAttribute

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

Description copied from interface: PluginContext

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

Specified by:

getAuthAttribute in interface PluginContext

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:

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

getAuthenticationBroker

AuthenticationBroker getAuthenticationBroker()

Description copied from interface: PluginContext

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

Specified by:

getAuthenticationBroker in interface PluginContext

Returns:

AuthenticationBroker associated with this logged in user

getAuthenticator

iMgrAuthenticator getAuthenticator()

Description copied from interface: PluginContext

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

Specified by:

getAuthenticator in interface MContext

Specified by:

getAuthenticator in interface PluginContext

Returns:

iMgrAuthenticator object

getContextPath

java.lang.String getContextPath()

Description copied from interface: PluginContext

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

Specified by:

getContextPath in interface PluginContext

Returns:

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

getDeviceType

java.lang.String getDeviceType()

Description copied from interface: PluginContext

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

Specified by:

getDeviceType in interface PluginContext

Returns:

String containing the current device type

getDirUtils

DirUtils getDirUtils()

Description copied from interface: PluginContext

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

Specified by:

getDirUtils in interface MContext

Specified by:

getDirUtils in interface PluginContext

Returns:

DirUtils object for directory methods

getLocale

java.util.Locale getLocale()

Description copied from interface: PluginContext

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

Specified by:

getLocale in interface PluginContext

Returns:

Locale object for use in the Task

getModulesPath

java.lang.String getModulesPath()

Description copied from interface: PluginContext

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

Specified by:

getModulesPath in interface PluginContext

Returns:

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

See Also:

PluginContext.getContextPath()

getPersistentData

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

Description copied from interface: PluginContext

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

Specified by:

getPersistentData in interface PluginContext

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:

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

getRequest

javax.servlet.http.HttpServletRequest getRequest()

Description copied from interface: PluginContext

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

Specified by:

getRequest in interface PluginContext

Returns:

The current HttpServletRequest

getSession

javax.servlet.http.HttpSession getSession()

Description copied from interface: PluginContext

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

Specified by:

getSession in interface PluginContext

Returns:

HttpSession object

See Also:

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

getTaskId

java.lang.String getTaskId()

Description copied from interface: PluginContext

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

Specified by:

getTaskId in interface PluginContext

Returns:

String containing the unique TaskID for this task

getWebappHome

java.io.File getWebappHome()

Description copied from interface: PluginContext

Returns a File pointing to the root of webapps.

Specified by:

getWebappHome in interface MContext

Specified by:

getWebappHome in interface PluginContext

Returns:

File pointing to the root of webapps

isTaskAvailable

boolean isTaskAvailable(java.lang.String taskId)

Description copied from interface: PluginContext

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

Specified by:

isTaskAvailable in interface PluginContext

Parameters:

taskId - String containing the unique ID of the Task

Returns:

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

removeAuthAttribute

void removeAuthAttribute(java.lang.Object attrKey)

Description copied from interface: PluginContext

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

Specified by:

removeAuthAttribute in interface PluginContext

Parameters:

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

See Also:

PluginContext.removeGlobalVar(java.lang.String)

removeFromHistory

void removeFromHistory(java.lang.String objectName)

Description copied from interface: PluginContext

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

Specified by:

removeFromHistory in interface MContext

Specified by:

removeFromHistory in interface PluginContext

Parameters:

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

setAuthAttribute

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

Description copied from interface: PluginContext

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

Specified by:

setAuthAttribute in interface PluginContext

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:

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

setPersistentData

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

Description copied from interface: PluginContext

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

Specified by:

setPersistentData in interface MContext

Specified by:

setPersistentData in interface PluginContext

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:

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