Package com.microstrategy.web.tasks
Class GetCubeBinaryResultsTask
- java.lang.Object
-
- com.microstrategy.web.tasks.AbstractBaseTask
-
- com.microstrategy.web.tasks.AbstractResultSetResultsTask
-
- com.microstrategy.web.tasks.AbstractResultSetBinaryResultsTask
-
- com.microstrategy.web.tasks.GetCubeBinaryResultsTask
-
- All Implemented Interfaces:
Task
public class GetCubeBinaryResultsTask extends AbstractResultSetBinaryResultsTask
-
-
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 GetCubeBinaryResultsTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
checkForRequiredParameters(RequestKeys requestKeys)
Checks whether all required parameters are present or not.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
getFileName(WebIServerSession session, java.lang.String msgID, int resultFlags)
protected int
getStatus(RequestKeys rk, java.lang.String sessionID)
void
processRequest(TaskRequestContext context, TaskOutput taskOutput)
Retrieves the Intelligence Server session, sets the result flags, requests the results (waiting until results are finished).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, getClassName, preCollectData, sendBinary
-
Methods inherited from class com.microstrategy.web.tasks.AbstractResultSetResultsTask
getSession, pollStatus
-
Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask
addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, newRequestContext, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType
-
-
-
-
Method Detail
-
processRequest
public void processRequest(TaskRequestContext context, TaskOutput taskOutput) throws TaskException
Description copied from class:AbstractResultSetResultsTask
Retrieves the Intelligence Server session, sets the result flags, requests the results (waiting until results are finished).- Specified by:
processRequest
in interfaceTask
- Overrides:
processRequest
in classAbstractResultSetResultsTask
- Parameters:
context
- TheTaskRequestContext
object that maintains the state of the request.taskOutput
- TheTaskOutput
that records the contents of the Task response.- Throws:
TaskException
- If the Task cannot complete as expected.TaskInternalException
- If the Task encounters an error on the Intelligence Server.- See Also:
Task.processRequest(TaskRequestContext, TaskOutput)
-
checkForRequiredParameters
protected void checkForRequiredParameters(RequestKeys requestKeys) throws TaskRequestMalformedException
Description copied from class:AbstractBaseTask
Checks whether all required parameters are present or not.- Overrides:
checkForRequiredParameters
in classAbstractBaseTask
- Parameters:
requestKeys
- TheRequestKeys
object that contains all parameters.- Throws:
TaskRequestMalformedException
- If some required parameters are missing.
-
getStatus
protected int getStatus(RequestKeys rk, java.lang.String sessionID) throws MSTRWebAPIException
- Specified by:
getStatus
in classAbstractResultSetResultsTask
- Throws:
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
-
getFileName
protected java.lang.String getFileName(WebIServerSession session, java.lang.String msgID, int resultFlags)
- Overrides:
getFileName
in classAbstractResultSetBinaryResultsTask
-
-