Package com.microstrategy.web.app.tasks

Class AppTaskRequestContext

java.lang.Object

com.microstrategy.web.tasks.BaseTaskRequestContext

com.microstrategy.web.app.tasks.AppTaskRequestContext

All Implemented Interfaces:

TaskRequestContext

Direct Known Subclasses:

BeanTaskRequestContext

public class AppTaskRequestContext
extends BaseTaskRequestContext

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

Since:

MicroStrategy Web 8.1.0

Field Summary

Fields inherited from class com.microstrategy.web.tasks.BaseTaskRequestContext

BLK_MESSAGE_RESULT, BLP_MESSAGE_RESULT_MESSAGE_ID, BLP_MESSAGE_RESULT_MESSAGE_STATE_ID, BLP_MESSAGE_RESULT_MESSAGE_STATUS, BLP_MESSAGE_RESULT_PARTIAL_MANIPULATIONS, mPrivileges

Constructor Summary

Constructors

Constructor	Description
AppTaskRequestContext()

Method Summary

Modifier and Type	Method	Description
AppContext	getAppContext()	Returns the AppContext object associated with this request.
BeanContext	getBeanContext()
protected BlockContext	getBlockContext(MarkupOutput markupOutput)	Returns the BlockContext object associated with this MarkupOutput.
StyleCatalog	getStyleCatalog()	Returns the StyleCatalog instance.
WebIServerSession	getWebIServerSession(java.lang.String sessionStateParamName, java.lang.String sessionIDParamName)	This method extends the one in BaseTaskRequestContext.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 WebIServerSession	restoreSessionFromStateOrId(java.lang.String sessionStateParamName, java.lang.String sessionIDParamName)

Methods inherited from class com.microstrategy.web.tasks.BaseTaskRequestContext

checkPrivileges, checkSessionAliveness, createMessageResultBlock, getBlock, getBlock, getBlockAssignmentMode, getContainerServices, getContentType, getIsPolling, getMimeType, getRequestKeys, getRootBlock, getRootBlock, getWebIServerSession, getWebIServerSession, isParameterEmpty, setBlockAssignmentMode, setContainerServices, setContentType, setIsPolling, setMimeType, setPrivileges, setRequestKeys, setRootBlock, setWebIServerSession, transformBlock

Methods inherited from class java.lang.Object

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

Constructor Detail

AppTaskRequestContext

public AppTaskRequestContext()

Method Detail

getAppContext

public AppContext getAppContext()

Returns the AppContext object associated with this request.

Returns:

The AppContext object associated with this request.

getWebIServerSession

public WebIServerSession getWebIServerSession(java.lang.String sessionStateParamName,
                                              java.lang.String sessionIDParamName)
                                       throws TaskException

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

Specified by:

getWebIServerSession in interface TaskRequestContext

Overrides:

getWebIServerSession in class BaseTaskRequestContext

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 - if either the session state or session ID are invalid (TaskRequestMalformedException) or the session has timed out (TaskInternalException).

restoreSessionFromStateOrId

protected WebIServerSession restoreSessionFromStateOrId(java.lang.String sessionStateParamName,
                                                        java.lang.String sessionIDParamName)
                                                 throws TaskRequestMalformedException

Overrides:

restoreSessionFromStateOrId in class BaseTaskRequestContext

Throws:

TaskRequestMalformedException

getStyleCatalog

public StyleCatalog getStyleCatalog()

Returns the StyleCatalog instance.

Returns:

the StyleCatalog instance.

getWebServletComponent

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.

Since:

MicroStrategy Web 9.0.0

getBlockContext

protected BlockContext getBlockContext(MarkupOutput markupOutput)

Description copied from class: BaseTaskRequestContext

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

Overrides:

getBlockContext in class BaseTaskRequestContext

Parameters:

markupOutput - The MarkupOutput object that hosts the BlockContext.

Returns:

The BlockContext object associated with this MarkupOutput.

Since:

MicroStrategy Web 9.0.0

getBeanContext

public BeanContext getBeanContext()

Overrides:

getBeanContext in class BaseTaskRequestContext