Package com.microstrategy.web.tasks

Class DocumentBinaryResultsTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.AbstractResultSetResultsTask

com.microstrategy.web.tasks.AbstractResultSetBinaryResultsTask

com.microstrategy.web.tasks.DocumentBinaryResultsTask

All Implemented Interfaces:

Task

public class DocumentBinaryResultsTask
extends AbstractResultSetBinaryResultsTask

This Task 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
DocumentBinaryResultsTask()

Method Summary

Modifier and Type	Method	Description
static void	addSortedTargetKeyCollection(WebXMLBuilder builder, java.util.SortedSet<java.lang.String> sorted)
static void	addSortedTargetKeyCollection(WebXMLBuilder builder, java.util.SortedSet<java.lang.String> sorted, java.util.Map<java.lang.String,java.lang.String> defnFilterProps, java.util.Map<java.lang.String,java.lang.String> dataFilterProps)
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

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentBinaryResultsTask

public DocumentBinaryResultsTask()

Method Detail

addSortedTargetKeyCollection

public static void addSortedTargetKeyCollection(WebXMLBuilder builder,
                                                java.util.SortedSet<java.lang.String> sorted)

addSortedTargetKeyCollection

public static void addSortedTargetKeyCollection(WebXMLBuilder builder,
                                                java.util.SortedSet<java.lang.String> sorted,
                                                java.util.Map<java.lang.String,java.lang.String> defnFilterProps,
                                                java.util.Map<java.lang.String,java.lang.String> dataFilterProps)

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 class AbstractResultSetBinaryResultsTask

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 class AbstractResultSetBinaryResultsTask

Throws:

MSTRWebAPIException

preCollectData

protected void preCollectData(TaskRequestContext context,
                              TaskOutput taskOutput)
                       throws TaskException,
                              WebObjectsException,
                              MSTRWebAPIException

Overrides:

preCollectData in class AbstractResultSetBinaryResultsTask

Throws:

TaskException

WebObjectsException

MSTRWebAPIException

pollStatus

protected void pollStatus(TaskRequestContext context,
                          TaskOutput taskOutput)
                   throws MSTRWebAPIException,
                          TaskException,
                          WebObjectsException

Overrides:

pollStatus in class AbstractResultSetResultsTask

Throws:

MSTRWebAPIException

TaskException

WebObjectsException

sendBinary

protected boolean sendBinary(TaskRequestContext context,
                             TaskOutput taskOutput)
                      throws TaskException,
                             WebObjectsException,
                             MSTRWebAPIException

Overrides:

sendBinary in class AbstractResultSetBinaryResultsTask

Throws:

TaskException

WebObjectsException

MSTRWebAPIException

getStatus

protected int getStatus(RequestKeys rk,
                        java.lang.String sessionID)
                 throws MSTRWebAPIException

Specified by:

getStatus in class AbstractResultSetResultsTask

Throws:

MSTRWebAPIException

getClassName

protected java.lang.String getClassName()

Overrides:

getClassName in class AbstractResultSetBinaryResultsTask