public class

TaskProcessor

extends Object
java.lang.Object
   ↳ com.microstrategy.web.controller.TaskProcessor

Summary

Nested Classes
enum TaskProcessor.TaskInvoker Enumeration that indicates the task Invoker in the incoming request. 
Constants
String PARAM_NAME_SESSION_STATE The name of the task parameter that identifies the IServer session state.
String PARAM_NAME_TASK_ID The URL parameter that specifies the Task to invoke.
Public Constructors
TaskProcessor()
Creates a new TaskProcessor object.
Public Methods
String getConfigurationError()
Returns the configuration error, if any, associated with the initialization of this task processor instance.
TaskFactory getRootFactory()
Return the root level TaskFactory associated with this configuration.
void initializeApp(ContainerServices cs)
Initialize the application.
boolean processRequest(TaskProcessorRequestState tpReqState)
Process the incoming request.
void terminateApp()
Terminate the application.
Protected Methods
Task getTaskInstance(String taskId, ContainerServices containerServices)
void initializeTaskFactory(ContainerServices cs)
String locateTaskId(RequestKeys requestKeys)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String PARAM_NAME_SESSION_STATE

The name of the task parameter that identifies the IServer session state.

Constant Value: "sessionState"

public static final String PARAM_NAME_TASK_ID

The URL parameter that specifies the Task to invoke.

Constant Value: "taskId"

Public Constructors

public TaskProcessor ()

Creates a new TaskProcessor object.

Public Methods

public String getConfigurationError ()

Returns the configuration error, if any, associated with the initialization of this task processor instance.

Returns
  • A String containing a configuration error.

public TaskFactory getRootFactory ()

Return the root level TaskFactory associated with this configuration.

Returns
  • A TaskFactory object instance that corresponds to the root task factory.

public void initializeApp (ContainerServices cs)

Initialize the application.

Parameters
cs The ContainerServices object to use to complete the initialization.

public boolean processRequest (TaskProcessorRequestState tpReqState)

Process the incoming request.

Parameters
tpReqState The TaskProcessorRequestState object that holds per-request data.
Returns
  • True, if the request was handled; otherwise, false.

public void terminateApp ()

Terminate the application.

Protected Methods

protected Task getTaskInstance (String taskId, ContainerServices containerServices)

Throws
TaskException

protected void initializeTaskFactory (ContainerServices cs)

protected String locateTaskId (RequestKeys requestKeys)

Throws
TaskException