Package com.microstrategy.web.controller
Class TaskProcessor
- java.lang.Object
-
- com.microstrategy.web.controller.TaskProcessor
-
public class TaskProcessor extends java.lang.Object
- Since:
- MicroStrategy Web 8.1.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TaskProcessor.TaskInvoker
Enumeration that indicates the task Invoker in the incoming request.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PARAM_NAME_SESSION_STATE
The name of the task parameter that identifies the IServer session state.static java.lang.String
PARAM_NAME_TASK_ID
The URL parameter that specifies the Task to invoke.
-
Constructor Summary
Constructors Constructor Description TaskProcessor()
Creates a new TaskProcessor object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getConfigurationError()
Returns the configuration error, if any, associated with the initialization of this task processor instance.TaskFactory
getRootFactory()
Return the root levelTaskFactory
associated with this configuration.protected Task
getTaskInstance(java.lang.String taskId, ContainerServices containerServices)
void
initializeApp(ContainerServices cs)
Initialize the application.protected void
initializeTaskFactory(ContainerServices cs)
protected java.lang.String
locateTaskId(RequestKeys requestKeys)
boolean
processRequest(TaskProcessorRequestState tpReqState)
Process the incoming request.void
terminateApp()
Terminate the application.
-
-
-
Field Detail
-
PARAM_NAME_TASK_ID
public static final java.lang.String PARAM_NAME_TASK_ID
The URL parameter that specifies the Task to invoke.- See Also:
- Constant Field Values
-
PARAM_NAME_SESSION_STATE
public static final java.lang.String PARAM_NAME_SESSION_STATE
The name of the task parameter that identifies the IServer session state.- See Also:
- Constant Field Values
-
-
Method Detail
-
initializeApp
public void initializeApp(ContainerServices cs)
Initialize the application.- Parameters:
cs
- TheContainerServices
object to use to complete the initialization.
-
processRequest
public boolean processRequest(TaskProcessorRequestState tpReqState)
Process the incoming request.- Parameters:
tpReqState
- TheTaskProcessorRequestState
object that holds per-request data.- Returns:
- True, if the request was handled; otherwise, false.
-
terminateApp
public void terminateApp()
Terminate the application.
-
getRootFactory
public TaskFactory getRootFactory()
Return the root levelTaskFactory
associated with this configuration.- Returns:
- A TaskFactory object instance that corresponds to the root task factory.
-
getConfigurationError
public java.lang.String getConfigurationError()
Returns the configuration error, if any, associated with the initialization of this task processor instance.- Returns:
- A String containing a configuration error.
-
getTaskInstance
protected Task getTaskInstance(java.lang.String taskId, ContainerServices containerServices) throws TaskException
- Throws:
TaskException
-
locateTaskId
protected java.lang.String locateTaskId(RequestKeys requestKeys) throws TaskException
- Throws:
TaskException
-
initializeTaskFactory
protected void initializeTaskFactory(ContainerServices cs)
-
-