Package com.microstrategy.web.controller

Class TaskViewerController

java.lang.Object

com.microstrategy.web.controller.TaskViewerController

All Implemented Interfaces:

AppController

public class TaskViewerController
extends java.lang.Object
implements AppController

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TaskViewerController.OptionInfo	This object holds information about an HTML Option element.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	REQ_ATTR_TASK_ADMIN_CONTEXT
static java.lang.String	URL_PARAM_ADMIN_PAGE

Constructor Summary

Constructors

Constructor	Description
TaskViewerController()

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 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.

Methods inherited from class java.lang.Object

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

Field Detail

URL_PARAM_ADMIN_PAGE

public static final java.lang.String URL_PARAM_ADMIN_PAGE

See Also:

Constant Field Values

REQ_ATTR_TASK_ADMIN_CONTEXT

public static final java.lang.String REQ_ATTR_TASK_ADMIN_CONTEXT

See Also:

Constant Field Values

Constructor Detail

TaskViewerController

public TaskViewerController()

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.

processRequest

public boolean processRequest(RequestState reqState)

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

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.

getPage

public java.lang.String getPage(RequestState reqState)

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

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.

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

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.

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.

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