Package com.microstrategy.web.tasks
Class OneTierRequestTask
- java.lang.Object
-
- com.microstrategy.web.tasks.AbstractBaseTask
-
- com.microstrategy.web.tasks.AbstractResultSetResultsTask
-
- com.microstrategy.web.tasks.AbstractResultSetBinaryResultsTask
-
- com.microstrategy.web.tasks.OneTierRequestTask
-
- All Implemented Interfaces:
Task
public class OneTierRequestTask extends AbstractResultSetBinaryResultsTask
ThisTask
provides the following functionality: it can retrieve the results associated with a Report Services document in binary format. If the document has not finished executing, it can poll for the results (observing a maximum wait time and a polling frequency value). Once the document is ready, the task will fetch the binary data of the document. Currently this task is used by the dashboards in flash format- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.tasks.AbstractResultSetBinaryResultsTask
resultDetailFlagsParam
-
Fields inherited from class com.microstrategy.web.tasks.AbstractResultSetResultsTask
MSG_PROMPT, MSG_TIMEOUT
-
Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask
compressOutput, CONTENT_TYPE_BINARY, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, CONTENT_TYPE_JSON_ALL, CONTENT_TYPE_JSON_D, CONTENT_TYPE_JSON_P, CONTENT_TYPE_XML, CONTENT_TYPE_XML_ANF, DEFAULT_MAX_WAIT, DEFAULT_POLLING_FREQ, execFlagsParam, INDEFINITE_MAX_WAIT, maxWaitParam, metadata, mPrivileges, msgIDParam, objectIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_MESSAGE_ID, PARAM_NAME_OBJECT_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, PARAM_NAME_STATE_ID, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam, stateIDParam
-
-
Constructor Summary
Constructors Constructor Description OneTierRequestTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected byte[]
getBinaryResults(RequestKeys rk, java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, IntWrapper iwStatus)
protected java.lang.String
getClassName()
protected int
getStatus(RequestKeys rk, java.lang.String sessionID)
protected void
pollStatus(TaskRequestContext context, TaskOutput taskOutput)
protected void
preCollectData(TaskRequestContext context, TaskOutput taskOutput)
protected boolean
sendBinary(TaskRequestContext context, TaskOutput taskOutput)
protected void
sendBinaryResults(RequestKeys rk, java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, IntWrapper iwStatus, IContentConsumer consumer)
-
Methods inherited from class com.microstrategy.web.tasks.AbstractResultSetBinaryResultsTask
createResponse, getFileName
-
Methods inherited from class com.microstrategy.web.tasks.AbstractResultSetResultsTask
getSession, processRequest
-
Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask
addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, checkForRequiredParameters, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, newRequestContext, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType
-
-
-
-
Method Detail
-
preCollectData
protected void preCollectData(TaskRequestContext context, TaskOutput taskOutput) throws TaskException, WebObjectsException, MSTRWebAPIException
- Overrides:
preCollectData
in classAbstractResultSetBinaryResultsTask
- Throws:
TaskException
WebObjectsException
MSTRWebAPIException
-
pollStatus
protected void pollStatus(TaskRequestContext context, TaskOutput taskOutput) throws MSTRWebAPIException, TaskException, WebObjectsException
- Overrides:
pollStatus
in classAbstractResultSetResultsTask
- Throws:
MSTRWebAPIException
TaskException
WebObjectsException
-
getStatus
protected int getStatus(RequestKeys rk, java.lang.String sessionID) throws MSTRWebAPIException
- Specified by:
getStatus
in classAbstractResultSetResultsTask
- Throws:
MSTRWebAPIException
-
sendBinary
protected boolean sendBinary(TaskRequestContext context, TaskOutput taskOutput) throws TaskException, WebObjectsException, MSTRWebAPIException
- Overrides:
sendBinary
in classAbstractResultSetBinaryResultsTask
- Throws:
TaskException
WebObjectsException
MSTRWebAPIException
-
getBinaryResults
protected byte[] getBinaryResults(RequestKeys rk, java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, IntWrapper iwStatus) throws MSTRWebAPIException
- Specified by:
getBinaryResults
in classAbstractResultSetBinaryResultsTask
- Throws:
MSTRWebAPIException
-
sendBinaryResults
protected void sendBinaryResults(RequestKeys rk, java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, IntWrapper iwStatus, IContentConsumer consumer) throws MSTRWebAPIException
- Specified by:
sendBinaryResults
in classAbstractResultSetBinaryResultsTask
- Throws:
MSTRWebAPIException
-
getClassName
protected java.lang.String getClassName()
- Overrides:
getClassName
in classAbstractResultSetBinaryResultsTask
-
-