public class

AppTaskRequestContext

extends BaseTaskRequestContext

java.lang.Object
↳	com.microstrategy.web.tasks.BaseTaskRequestContext
	↳	com.microstrategy.web.app.tasks.AppTaskRequestContext

Known Direct Subclasses

BeanTaskRequestContext

Class Overview

The class provides more application context for a Task which extends AbstractAppTask.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.tasks.BaseTaskRequestContext

[Expand]

Inherited Fields

From class com.microstrategy.web.tasks.BaseTaskRequestContext

Public Constructors
	AppTaskRequestContext()

Public Methods
AppContext	getAppContext() Returns the AppContext object associated with this request.
BeanContext	getBeanContext()
StyleCatalog	getStyleCatalog() Returns the StyleCatalog instance.
WebIServerSession	getWebIServerSession(String sessionStateParamName, String sessionIDParamName) This method extends the one in `getWebIServerSession(String, String)` by using the "active session" of the `SessionManager` if no WebIServerSession object could be provided from the base method.
ServletWebComponent	getWebServletComponent() Return an instance of a ServletWebComponent for use in performing MSTR Web system actions.

Protected Methods
BlockContext	getBlockContext(MarkupOutput markupOutput) Returns the BlockContext object associated with this MarkupOutput.
WebIServerSession	restoreSessionFromStateOrId(String sessionStateParamName, String sessionIDParamName)

[Expand]

Inherited Methods

From class com.microstrategy.web.tasks.BaseTaskRequestContext

void	checkPrivileges()
void	checkSessionAliveness(WebIServerSession wiss) Checks whether the supplied WebIServerSession instance is alive or not.
Block	createMessageResultBlock(WebResultSetInstance wrsi) This method creates a Block of type "MessageResult" and populates it with the properties of the supplied `WebResultSetInstance` object.
BeanContext	getBeanContext()
Block	getBlock(String blockName) Gets a Block from the Block Library.
Block	getBlock(String blockName, int blockMode) This method is deprecated. Please use `getBlock(String)` instead
String	getBlockAssignmentMode() Returns the default block assignment mode used for all Block creation.
BlockContext	getBlockContext(MarkupOutput markupOutput) Returns the BlockContext object associated with this MarkupOutput.
ContainerServices	getContainerServices() Returns the ContainerServices object associated with this request.
String	getContentType() Gets the desired Content Type specified by the caller for this Task invocation.
boolean	getIsPolling() Returns the isPolling flag
String	getMimeType() Gets the desired MIME Type specified by the caller for this Task invocation.
RequestKeys	getRequestKeys() Returns the RequestKeys object associated with this request.
Block	getRootBlock(String blockName, int blockMode) This method is deprecated. Please use `getRootBlock(String, MarkupOutput)` instead
Block	getRootBlock(String blockName, MarkupOutput markupOutput) If a Task uses a Block to construct output content, then this method gets the "root" Block associated with a MarkupOutput object.
WebIServerSession	getWebIServerSession(String sessionStateParamName, String sessionIDParamName, boolean checkSessionAliveness)
WebIServerSession	getWebIServerSession() Returns the held WebIServerSession instance.
WebIServerSession	getWebIServerSession(String sessionStateParamName, String sessionIDParamName) Returns the WebIServerSession object associated with this request.
boolean	isParameterEmpty(TaskParameterMetadata tpm) This method checks if the the Task Parameter (identified by the TaskParameterMetadata) in a request is empty or not.
WebIServerSession	restoreSessionFromStateOrId(String sessionStateParamName, String sessionIDParamName)
void	setBlockAssignmentMode(String blockMode) Sets the default block assignment mode used for all Block creation.
void	setContainerServices(ContainerServices cntrSvcs) Sets the ContainerServices object associated with this request.
void	setContentType(String contentType) Sets the desired Content Type specified by the caller for this Task invocation.
void	setIsPolling(boolean value) Sets the isPolling flag indicating whether this task is in polling state (waiting for server response while polling with the client) Useful to set the response to client accordingly
void	setMimeType(String mimeType) Sets the desired MIME Type specified by the caller for this Task invocation.
void	setPrivileges(WebPrivilegesExpression privileges) Stores the task privileges to check them when we get a session
void	setRequestKeys(RequestKeys requestKeys) Sets the RequestKeys object associated with this request.
void	setRootBlock(Block rootBlock, MarkupOutput markupOutput) This method sets the root Block of the markupOutput to the supplied Block.
void	setWebIServerSession(WebIServerSession wiss) Sets the WebIServerSession object associated with this request.
Block	transformBlock(Block rootBlock, String blockScript) Transform a Block into another form using a Block Transform "script".

From class java.lang.Object

From interface com.microstrategy.web.tasks.TaskRequestContext

abstract Block	createMessageResultBlock(WebResultSetInstance wrsi) This method creates a Block of type "MessageResult" and populates it with the properties of the supplied `WebResultSetInstance` object.
abstract Block	getBlock(String blockName) Gets a Block from the Block Library.
abstract String	getBlockAssignmentMode() Returns the default block assignment mode used for all Block creation.
abstract ContainerServices	getContainerServices() Returns the ContainerServices object associated with this request.
abstract String	getContentType() Gets the desired Content Type specified by the caller for this Task invocation.
abstract boolean	getIsPolling() Returns the isPolling flag
abstract String	getMimeType() Gets the desired MIME Type specified by the caller for this Task invocation.
abstract RequestKeys	getRequestKeys() Returns the RequestKeys object associated with this request.
abstract Block	getRootBlock(String blockName, MarkupOutput markupOutput) If a Task uses a Block to construct output content, then this method gets the "root" Block associated with a MarkupOutput object.
abstract WebIServerSession	getWebIServerSession(String sessionStateParamName, String sessionIDParamName) Returns the WebIServerSession object associated with this request.
abstract boolean	isParameterEmpty(TaskParameterMetadata tpm) This method checks if the the Task Parameter (identified by the TaskParameterMetadata) in a request is empty or not.
abstract void	setBlockAssignmentMode(String blockMode) Sets the default block assignment mode used for all Block creation.
abstract void	setContainerServices(ContainerServices cntrSvcs) Sets the ContainerServices object associated with this request.
abstract void	setContentType(String contentType) Sets the desired Content Type specified by the caller for this Task invocation.
abstract void	setIsPolling(boolean value) Sets the isPolling flag indicating whether this task is in polling state (waiting for server response while polling with the client) Useful to set the response to client accordingly
abstract void	setMimeType(String mimeType) Sets the desired MIME Type specified by the caller for this Task invocation.
abstract void	setPrivileges(WebPrivilegesExpression value) Sets the task privileges.
abstract void	setRequestKeys(RequestKeys requestKeys) Sets the RequestKeys object associated with this request.
abstract void	setRootBlock(Block block, MarkupOutput markupOutput) This method sets the root Block of the markupOutput to the supplied Block.
abstract void	setWebIServerSession(WebIServerSession wiss) Sets the WebIServerSession object associated with this request.
abstract Block	transformBlock(Block rootBlock, String blockScript) Transform a Block into another form using a Block Transform "script".

Public Constructors

public AppTaskRequestContext ()

Public Methods

public AppContext getAppContext ()

Returns the AppContext object associated with this request.

Returns

The AppContext object associated with this request.

public BeanContext getBeanContext ()

public StyleCatalog getStyleCatalog ()

Returns the StyleCatalog instance.

Returns

the StyleCatalog instance.

public WebIServerSession getWebIServerSession (String sessionStateParamName, String sessionIDParamName)

This method extends the one in getWebIServerSession(String, String) by using the "active session" of the SessionManager if no WebIServerSession object could be provided from the base method.

Parameters

sessionStateParamName	The name of the incoming request key ("parameter name") that contains a session state.
sessionIDParamName	The name of the incoming request key ("parameter name") that contains a session ID.

Returns

The WebIServerSession object associated with this request.

Throws

TaskRequestMalformedException	If a previous state or session ID is supplied, but invalid, or if the session has timed out.
TaskException

public ServletWebComponent getWebServletComponent ()

Return an instance of a ServletWebComponent for use in performing MSTR Web system actions.

Returns

A ServletWebComponent that may be used for performing MSTR Web system actions.

Protected Methods

protected BlockContext getBlockContext (MarkupOutput markupOutput)

Returns the BlockContext object associated with this MarkupOutput. If none exists, then one is created. It is automatically populated with the following fields:

Content Type
Container Services
Request Keys

Parameters

markupOutput	The `MarkupOutput` object that hosts the `BlockContext`.

Returns

The BlockContext object associated with this MarkupOutput.

protected WebIServerSession restoreSessionFromStateOrId (String sessionStateParamName, String sessionIDParamName)

Throws

TaskRequestMalformedException

Classes

AppTaskRequestContext

Class Overview

Summary

Public Constructors

public AppTaskRequestContext ()

Public Methods

public AppContext getAppContext ()

Returns

public BeanContext getBeanContext ()

public StyleCatalog getStyleCatalog ()

Returns

public WebIServerSession getWebIServerSession (String sessionStateParamName, String sessionIDParamName)

Parameters

Returns

Throws

public ServletWebComponent getWebServletComponent ()

Returns

Protected Methods

protected BlockContext getBlockContext (MarkupOutput markupOutput)

Parameters

Returns

protected WebIServerSession restoreSessionFromStateOrId (String sessionStateParamName, String sessionIDParamName)

Throws