com.novell.emframe.dev

Class MTask

java.lang.Object

com.novell.emframe.dev.MTask

Direct Known Subclasses:

MPropertyBook

public abstract class MTask
extends java.lang.Object

Abstract class to simply writing a Task to iManager. Instead, use Task.

Constructor Summary

Constructors

Constructor and Description
MTask()

Method Summary

Modifier and Type	Method and Description
abstract void	execute(MContext context) The purpose of this method is to do or dispatch all buisness work required.
MContext	getContext() Get the current MContext, may return a context that does not have a valid request.
javax.servlet.http.HttpServletRequest	getRequest() Get the current request.
javax.servlet.http.HttpSession	getSession() Get the session corresponding to this instance
boolean	getTaskComplete() Returns whether the task is complete or not.
java.lang.String	getTaskId() Returns the ID of this task (must be the ID used to register the task in the XML descriptor).
java.lang.String	getTaskInstanceId() Returns the instance specific ID of this task (may be different than the ID used to register the task in the XML descriptor).
java.lang.String	getUIPage() Returns the name of the current JSP file used by this task.
void	init(com.novell.emframe.fw.servlet.FwSession session) Method allows the framework to initialize the MTask instance.
void	init(MContext context, org.jdom.Document doc) Initialize the task to be ready for first execute method.
void	release() Called by the framework when the iManTask been released and should be garbage collected in the future.
void	render(MContext context, javax.servlet.http.HttpServletResponse response) The purpose of this method is to render the data into markup to be sent to the client.
void	setTaskComplete(boolean complete) Call this method to inform the framework that you have completed and it is time to move on.
void	setUIPage(java.lang.String jspPage) This should be called from the execute method to tell the framework which JSP to should be used to render the data into HTML (or other markup).
static void	shouldRun(javax.servlet.http.HttpServletRequest req, java.lang.String taskId) This function is called to see if the iManTask should be run based upon conditions known to the task.

Methods inherited from class java.lang.Object

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

Constructor Detail

MTask

public MTask()

Method Detail

init

public final void init(com.novell.emframe.fw.servlet.FwSession session)

Method allows the framework to initialize the MTask instance. This MUST NEVER be called by anyone other than the framework.

execute

public abstract void execute(MContext context)

The purpose of this method is to do or dispatch all buisness work required. Then place data that will be displayed to the user in the request attributes (request.setAttribute(key, value). This data will be rendered into markup (ex. HTML) by the render method (calls JSP specified).

Parameters:

context - TaskContext provides access to framework and session data (ex. locale)

render

public void render(MContext context,
                   javax.servlet.http.HttpServletResponse response)

The purpose of this method is to render the data into markup to be sent to the client. This method should directly or indirectly write to the response. By overriding this method, the task writer gains the flexiblity of rendering the data in anyway they prefer. For example this method can be overridden to handle the download of a file to the client machine. This default implementatin dispatches a JSP that has access to the data. It is up to the JSP to provide the complete response.

Parameters:

context - TaskContext provides access to framework and session data (ex. locale)

response - HttpServletResponse to render data

init

public void init(MContext context,
                 org.jdom.Document doc)

Initialize the task to be ready for first execute method.

Parameters:

context - TaskContext provides access to framework and session data (ex. locale)

doc - XML Document used to register task with iManager

setUIPage

public void setUIPage(java.lang.String jspPage)

This should be called from the execute method to tell the framework which JSP to should be used to render the data into HTML (or other markup).

Parameters:

jspPage - String containing the JSP file to use in the form of moduleid/filename (ex. "dirxml/MyTask.jsp" where dirxml is the moduleid and MyTask.jsp is the file name)

See Also:

getUIPage()

getUIPage

public java.lang.String getUIPage()

Returns the name of the current JSP file used by this task.

Returns:

String containing the JSP file to use in the form of moduleid/filename (ex. "dirxml/MyTask.jsp" where dirxml is the moduleid and MyTask.jsp is the file name)

See Also:

setUIPage(java.lang.String)

shouldRun

public static void shouldRun(javax.servlet.http.HttpServletRequest req,
                             java.lang.String taskId)
                      throws java.lang.Exception

This function is called to see if the iManTask should be run based upon conditions known to the task. For instance, by default the function calls supportsDeviceCharacteristics(). Other conditions could be an unsupported server operating system, current user logged into the tree, etc.... If the task overwrites this method, it should always call MTaskUtils.supportsDeviceCharacteristics() first so the system can do its checks. Simply return if the gadget should be able to run. Otherwise, throw an exception with a descriptive string describing why the gadget cannot run.

Parameters:

req - The current HttpServletRequest

taskId - String containing the task id as registered in the XML descriptor

Throws:

java.lang.Exception - with a descriptive string describing why the gadget cannot run

release

public void release()

Called by the framework when the iManTask been released and should be garbage collected in the future. Note: Tasks that have registered with the Authbroker or other framework events should use this to remove themselves as well as releasing any resources they may be holding.

getTaskInstanceId

public final java.lang.String getTaskInstanceId()

Returns the instance specific ID of this task (may be different than the ID used to register the task in the XML descriptor).

Returns:

String containing the instance specific ID of this task

getTaskId

public final java.lang.String getTaskId()

Returns the ID of this task (must be the ID used to register the task in the XML descriptor).

Returns:

String containing the ID of this task from XML descriptor

setTaskComplete

public void setTaskComplete(boolean complete)

Call this method to inform the framework that you have completed and it is time to move on.

Parameters:

complete -

getTaskComplete

public boolean getTaskComplete()

Returns whether the task is complete or not.

Returns:

boolean

getSession

public javax.servlet.http.HttpSession getSession()

Get the session corresponding to this instance

Returns:

HttpSession

Since:

2.7

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Get the current request. May return null

Returns:

HttpServletRequest

Since:

2.7

getContext

public MContext getContext()

Get the current MContext, may return a context that does not have a valid request.

Returns:

MContext

Since:

2.7