public class

TaskViewerController

extends Object
implements AppController
java.lang.Object
   ↳ com.microstrategy.web.controller.TaskViewerController

Class Overview

This class is the AppController implementation for the TaskViewer servlet. It is designed for GUI construction of the task tool interface without any task execution job involved. It is used by both TaskViewer and TaskAdmin severlets/pages, and the tool interface could be different based on the configuration file.

Summary

Nested Classes
class TaskViewerController.OptionInfo This object holds information about an HTML Option element. 
Constants
String REQ_ATTR_TASK_ADMIN_CONTEXT
String URL_PARAM_ADMIN_PAGE
Public Constructors
TaskViewerController()
Public Methods
void errorAfterRedirect(RequestState reqState, Exception e)
Inform the application that the request has failed inside the redirected page
String getBaseURL(ContainerServices cs)
Returns the root name to use on event links and as the action of the forms generated by the application
String getPage(RequestState reqState)
Get the relative path to the Page that should be displayed in the tool interface.
void initializeApp(ContainerServices cs)
Initialize the application.
ExternalSecurity newExternalSecurity()
Creates new instance of the ExternalSecurity component to be used for authenticating and authorizing users on each of their requests.
RequestState newRequestState()
Get a new RequestState object to handle the incoming request.
boolean processRequest(RequestState reqState)
Process the incoming request.
void terminateApp()
Terminate the application.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.controller.AppController

Constants

public static final String REQ_ATTR_TASK_ADMIN_CONTEXT

Constant Value: "com.microstrategy.web.tasks.AdminContext"

public static final String URL_PARAM_ADMIN_PAGE

Constant Value: "pg"

Public Constructors

public TaskViewerController ()

Public Methods

public void errorAfterRedirect (RequestState reqState, Exception e)

Inform the application that the request has failed inside the redirected page

public String getBaseURL (ContainerServices cs)

Returns the root name to use on event links and as the action of the forms generated by the application

Returns
  • String

public String getPage (RequestState reqState)

Get the relative path to the Page that should be displayed in the tool interface.

Parameters
reqState The RequestState object that contains per-request data structures.
Returns
  • The path to the Page to internally redirect to.

public void initializeApp (ContainerServices cs)

Initialize the application.

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

public ExternalSecurity newExternalSecurity ()

Creates new instance of the ExternalSecurity component to be used for authenticating and authorizing users on each of their requests.

Returns
  • new instance of the ExternalSecurity component.

public RequestState newRequestState ()

Get a new RequestState object to handle the incoming request.

Returns

public boolean processRequest (RequestState reqState)

Process the incoming request. Just do nothing since this controller is dedicated to task tool interface generation.

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

public void terminateApp ()

Terminate the application. This allows the application to cleanup any persistent data structures.