Package com.microstrategy.web.controller

Interface AppController

All Known Implementing Classes:

AdminController, AppControllerImpl, GenericWebAppController, MobileController, MSTRWebController, OldLinksController, ResourceFeedController, ServerAdminController, TaskAdminController, TaskProcessorController, TaskViewerController

public interface AppController

Since:

MicroStrategy Web 7.3.1 or earlier

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 page to redirect to.
void	initializeApp(ContainerServices cs)	Initialize our web 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()	Create a new per-request data structure
boolean	processRequest(RequestState reqState)	Handle an incoming HTTP Request.
void	terminateApp()	Terminate the application.

Method Detail

initializeApp

void initializeApp(ContainerServices cs)

Initialize our web application. Save all persistent data structures back into the implementation class as private data members.

Parameters:

cs -

newRequestState

RequestState newRequestState()

Create a new per-request data structure

Returns:

RequestState

processRequest

boolean processRequest(RequestState reqState)

Handle an incoming HTTP Request. The state of the incoming request is saved back into the RequestState object for later review by the controller.

Parameters:

reqState -

Returns:

boolean

errorAfterRedirect

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

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

Parameters:

reqState -

e -

getPage

java.lang.String getPage(RequestState reqState)

Get the page to redirect to. Must handle the case that an error was found before redirection. In such a case, the page returned should be an error page.

Parameters:

reqState -

Returns:

String

getBaseURL

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

Parameters:

cs -

Returns:

String

newExternalSecurity

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.

terminateApp

void terminateApp()

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

Since:

MicroStrategy Web 8.1.0