| java.lang.Object | |
| ↳ | com.microstrategy.web.controller.TaskAdminController |
Class Overview
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.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| TaskAdminController() | |||||||||||
| 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.
| ||||||||||
| 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
| |||||||||||
Public Constructors
public TaskAdminController ()
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. If no task ID is specified, return the tool interface HTML page, otherwise, return the execution result page in format of the specified envelop.
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
- A new
RequestStateobject to handle the incoming request.
public boolean processRequest (RequestState reqState)
Process the incoming request. Delegates to task processor controller.
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.