Package com.microstrategy.web.app.tasks

Class SessionAliveTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.AbstractAppTask

com.microstrategy.web.app.tasks.SessionAliveTask

All Implemented Interfaces:

Task

public class SessionAliveTask
extends AbstractAppTask

This task checks whether an Intelligence Server session is alive.

Since:

MicroStrategy Web Polaris

Field Summary

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
SessionAliveTask()	Default no args constructor

Method Summary

Modifier and Type	Method	Description
void	processRequest(TaskRequestContext context, TaskOutput out)	This task tries to check for whether the WebIServerSession is timeout.

Methods inherited from class com.microstrategy.web.app.tasks.AbstractAppTask

getDescriptor, newRequestContext

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, 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

SessionAliveTask

public SessionAliveTask()

Default no args constructor

Method Detail

processRequest

public void processRequest(TaskRequestContext context,
                           TaskOutput out)
                    throws TaskException

This task tries to check for whether the WebIServerSession is timeout. If session is alive, returns the remaining time to be active. If task fails or session is timeout, returns -1L.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

context - The TaskRequestContext object that maintains the state of the request.

out - taskOutput The TaskOutput that records the contents of the Task response.

Throws:

TaskException - If the session is not alive.

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)