Package com.microstrategy.web.app.tasks

Class GetSessionStateTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.AbstractAppTask

com.microstrategy.web.app.tasks.GetSessionStateTask

All Implemented Interfaces:

Task

public class GetSessionStateTask
extends AbstractAppTask

A simple Task that logs a user into an Intelligence Server.

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAM_NAME_APP_TYPE	Application Type
static java.lang.String	PARAM_NAME_AUTH_MODE	The name of the authentication mode parameter.
static java.lang.String	PARAM_NAME_CLIENT_ID	The client ID
static java.lang.String	PARAM_NAME_DATA_LOCALE_ID	The data locale ID
static java.lang.String	PARAM_NAME_DISPLAY_LOCALE_ID	The display Locale ID
protected static java.lang.String	PARAM_NAME_L	The name of the user ID parameter.
static java.lang.String	PARAM_NAME_METADATA_LOCALE_ID	The metadata Locale ID
static java.lang.String	PARAM_NAME_OLD_SESSION_INFO	The old session info container
static java.lang.String	PARAM_NAME_OLD_SESSION_STATE	The old session state
protected static java.lang.String	PARAM_NAME_P	The name of the p parameter.
static java.lang.String	PARAM_NAME_PORT	The port of the server
protected static java.lang.String	PARAM_NAME_PROJECT	The name of the project parameter.
static java.lang.String	PARAM_NAME_REGULAR_WORKING_SET_SIZE	The regular working set size
static java.lang.String	PARAM_NAME_SERVER	The name of the server parameter.
static java.lang.String	PARAM_NAME_SESSION_FLAGS	The session flag
static java.lang.String	PARAM_NAME_WAREHOUSE_DATA_LOCALE_ID	The warehouse data locale ID

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
GetSessionStateTask()	Creates a new LoginTask object.

Method Summary

Modifier and Type	Method	Description
void	processRequest(TaskRequestContext context, MarkupOutput markupOutput)	Creates an Intelligence Server session using the information supplied in the request.

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

Field Detail

PARAM_NAME_SERVER

public static final java.lang.String PARAM_NAME_SERVER

The name of the server parameter.

See Also:

Constant Field Values

PARAM_NAME_PORT

public static final java.lang.String PARAM_NAME_PORT

The port of the server

See Also:

Constant Field Values

PARAM_NAME_PROJECT

protected static final java.lang.String PARAM_NAME_PROJECT

The name of the project parameter.

See Also:

Constant Field Values

PARAM_NAME_P

protected static final java.lang.String PARAM_NAME_P

The name of the p parameter.

See Also:

Constant Field Values

PARAM_NAME_L

protected static final java.lang.String PARAM_NAME_L

The name of the user ID parameter.

See Also:

Constant Field Values

PARAM_NAME_AUTH_MODE

public static final java.lang.String PARAM_NAME_AUTH_MODE

The name of the authentication mode parameter.

See Also:

Constant Field Values

PARAM_NAME_DISPLAY_LOCALE_ID

public static final java.lang.String PARAM_NAME_DISPLAY_LOCALE_ID

The display Locale ID

See Also:

Constant Field Values

PARAM_NAME_DATA_LOCALE_ID

public static final java.lang.String PARAM_NAME_DATA_LOCALE_ID

The data locale ID

See Also:

Constant Field Values

PARAM_NAME_METADATA_LOCALE_ID

public static final java.lang.String PARAM_NAME_METADATA_LOCALE_ID

The metadata Locale ID

Since:

MicroStrategy Web 9.0.1

See Also:

Constant Field Values

PARAM_NAME_WAREHOUSE_DATA_LOCALE_ID

public static final java.lang.String PARAM_NAME_WAREHOUSE_DATA_LOCALE_ID

The warehouse data locale ID

Since:

MicroStrategy Web 9.0.1

See Also:

Constant Field Values

PARAM_NAME_CLIENT_ID

public static final java.lang.String PARAM_NAME_CLIENT_ID

The client ID

See Also:

Constant Field Values

PARAM_NAME_REGULAR_WORKING_SET_SIZE

public static final java.lang.String PARAM_NAME_REGULAR_WORKING_SET_SIZE

The regular working set size

See Also:

Constant Field Values

PARAM_NAME_SESSION_FLAGS

public static final java.lang.String PARAM_NAME_SESSION_FLAGS

The session flag

See Also:

Constant Field Values

PARAM_NAME_OLD_SESSION_STATE

public static final java.lang.String PARAM_NAME_OLD_SESSION_STATE

The old session state

See Also:

Constant Field Values

PARAM_NAME_OLD_SESSION_INFO

public static final java.lang.String PARAM_NAME_OLD_SESSION_INFO

The old session info container

See Also:

Constant Field Values

PARAM_NAME_APP_TYPE

public static final java.lang.String PARAM_NAME_APP_TYPE

Application Type

See Also:

Constant Field Values

Constructor Detail

GetSessionStateTask

public GetSessionStateTask()

Creates a new LoginTask object.

Method Detail

processRequest

public void processRequest(TaskRequestContext context,
                           MarkupOutput markupOutput)
                    throws TaskException

Creates an Intelligence Server session using the information supplied in the request.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

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

markupOutput - The MarkupOutput that records the contents of the Task response.

Throws:

TaskException - If the Task is unable to obtain a Block to store the results.

TaskRequestMalformedException - If any of the information is incorrect.

See Also:

Task.processRequest(TaskRequestContext, MarkupOutput)