Package com.microstrategy.web.controller

Class TaskAdminController

java.lang.Object

com.microstrategy.web.controller.TaskAdminController

All Implemented Interfaces:

AppController

public class TaskAdminController
extends java.lang.Object
implements AppController

This class is the AppController implementation for the TaskAdmin servlet. It is designed for handling the execution of administrative tasks, as well it generates the tool interface of "Task Administrator" when task ID is absent in the request keys.

From architectural aspect, this controller delegates task execution to TaskProcessorController and delegates GUI construction to taskViewerController.

Constructor Summary

Constructors

Constructor	Description
TaskAdminController()

Method Summary

Modifier and Type	Method	Description
void	errorAfterRedirect(RequestState reqState, java.lang.Exception e)	Inform the application that the request has failed inside the redirected page
java.lang.String	getBaseURL(ContainerServices cs)	Returns the root name to use on event links and as the action of the forms generated by the application
java.lang.String	getPage(RequestState reqState)	Get the relative path to the Page that should be displayed.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskAdminController

public TaskAdminController()

Method Detail

initializeApp

public void initializeApp(ContainerServices cs)

Initialize the application.

Specified by:

initializeApp in interface AppController

Parameters:

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

newRequestState

public RequestState newRequestState()

Get a new RequestState object to handle the incoming request.

Specified by:

newRequestState in interface AppController

Returns:

A new RequestState object to handle the incoming request.

errorAfterRedirect

public void errorAfterRedirect(RequestState reqState,
                               java.lang.Exception e)

Description copied from interface: AppController

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

Specified by:

errorAfterRedirect in interface AppController

getBaseURL

public java.lang.String getBaseURL(ContainerServices cs)

Description copied from interface: AppController

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

Specified by:

getBaseURL in interface AppController

Returns:

String

getPage

public java.lang.String getPage(RequestState reqState)

Get the relative path to the Page that should be displayed. If no task ID is specified, return the tool interface HTML page, otherwise, return the execution result page in format of the specified envelop.

Specified by:

getPage in interface AppController

Parameters:

reqState - The RequestState object that contains per-request data structures.

Returns:

The path to the Page to internally redirect to.

newExternalSecurity

public ExternalSecurity newExternalSecurity()

Description copied from interface: AppController

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

Specified by:

newExternalSecurity in interface AppController

Returns:

new instance of the ExternalSecurity component.

processRequest

public boolean processRequest(RequestState reqState)

Process the incoming request. Delegates to task processor controller.

Specified by:

processRequest in interface AppController

Parameters:

reqState - The RequestState object that holds per-request data.

Returns:

True, if the request was handled; otherwise, false.

terminateApp

public void terminateApp()

Description copied from interface: AppController

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

Specified by:

terminateApp in interface AppController