TaskProcessorController

Class Overview

This class is the AppController implementation for the TaskProcessor servlet. It contains the majority of the logic for handling incoming task requests, dispatching them to the appropriate tasks and formatting their results for the desired consumer.

This controller is responsible for generating the entire task response. There are two parts to this response: the envelope and the payload. The "payload" is easiest to understand: it is the result generated by the underlying task. The "envelope" is the markup that encapsulates the "payload". The envelope is often structured for the caller's consumption.

For example, the IFRAME envelope consists of a full HTML document with the BODY element specifying a JavaScript function to invoke for the 'onload' handler. An XMLHttpRequest envelope will contain less "wiring" to indicate when the request is complete.

Three HTTP parameters are relevant at this stage of task processing: the task ID (known through the constant PARAM_NAME_TASK_ID), the task envelope (known through the constant PARAM_NAME_TASK_ENVELOPE) and the task Content Type (know through the constant PARAM_NAME_TASK_CONTENT_TYPE). The task ID identifies the registered Task, the envelope specifies a set of pages that are used to contain the payload and the content type specifies the desired output format. If omitted, it defaults to whatever is specified by the envelope.

Summary

[Expand] Inherited Methods
From class com.microstrategy.web.controller.AppControllerImpl void terminateApp() Subclasses that override this method should invoke this via super.terminateApp to ensure threads and other application related resources are cleaned up properly.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.microstrategy.web.controller.AppController abstract void errorAfterRedirect(RequestState reqState, Exception e) Inform the application that the request has failed inside the redirected page abstract String getBaseURL(ContainerServices cs) Returns the root name to use on event links and as the action of the forms generated by the application abstract String getPage(RequestState reqState) Get the page to redirect to. abstract void initializeApp(ContainerServices cs) Initialize our web application. abstract ExternalSecurity newExternalSecurity() Creates new instance of the ExternalSecurity component to be used for authenticating and authorizing users on each of their requests. abstract RequestState newRequestState() Create a new per-request data structure abstract boolean processRequest(RequestState reqState) Handle an incoming HTTP Request. abstract void terminateApp() Terminate the application.