Package com.microstrategy.web.tasks
Class AbstractResultSetBinaryResultsTask
- java.lang.Object
-
- com.microstrategy.web.tasks.AbstractBaseTask
-
- com.microstrategy.web.tasks.AbstractResultSetResultsTask
-
- com.microstrategy.web.tasks.AbstractResultSetBinaryResultsTask
-
- All Implemented Interfaces:
Task
- Direct Known Subclasses:
DocumentBinaryResultsTask
,GetCubeBinaryResultsTask
,OneTierRequestTask
,ReportBinaryResultsTask
public abstract class AbstractResultSetBinaryResultsTask extends AbstractResultSetResultsTask
-
-
Field Summary
Fields Modifier and Type Field Description protected TaskParameterMetadata
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 AbstractResultSetBinaryResultsTask(java.lang.String taskDesc)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected boolean
createResponse(TaskRequestContext context, TaskOutput output)
protected abstract 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 java.lang.String
getFileName(WebIServerSession session, java.lang.String msgID, int resultFlags)
protected void
preCollectData(TaskRequestContext context, TaskOutput taskOutput)
protected boolean
sendBinary(TaskRequestContext context, TaskOutput taskOutput)
protected abstract 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.AbstractResultSetResultsTask
getSession, getStatus, pollStatus, 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
-
-
-
-
Field Detail
-
resultDetailFlagsParam
protected TaskParameterMetadata resultDetailFlagsParam
-
-
Method Detail
-
getFileName
protected java.lang.String getFileName(WebIServerSession session, java.lang.String msgID, int resultFlags)
-
getClassName
protected java.lang.String getClassName()
-
sendBinary
protected boolean sendBinary(TaskRequestContext context, TaskOutput taskOutput) throws TaskException, WebObjectsException, MSTRWebAPIException
-
createResponse
protected boolean createResponse(TaskRequestContext context, TaskOutput output) throws MSTRWebAPIException, WebObjectsException, TaskException
- Specified by:
createResponse
in classAbstractResultSetResultsTask
- Throws:
MSTRWebAPIException
WebObjectsException
TaskException
-
preCollectData
protected void preCollectData(TaskRequestContext context, TaskOutput taskOutput) throws TaskException, WebObjectsException, MSTRWebAPIException
- Specified by:
preCollectData
in classAbstractResultSetResultsTask
- Throws:
TaskException
WebObjectsException
MSTRWebAPIException
-
sendBinaryResults
protected abstract void sendBinaryResults(RequestKeys rk, java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, IntWrapper iwStatus, IContentConsumer consumer) throws MSTRWebAPIException
- Throws:
MSTRWebAPIException
-
getBinaryResults
protected abstract byte[] getBinaryResults(RequestKeys rk, java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, IntWrapper iwStatus) throws MSTRWebAPIException
- Throws:
MSTRWebAPIException
-
-