Package com.microstrategy.web.app.tasks

Class LoginFirstTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.LoginFirstTask

All Implemented Interfaces:

Task

public class LoginFirstTask
extends AbstractBaseTask

Field Summary

Fields

Modifier and Type	Field	Description
protected TaskParameterMetadata	applicationTypeTaskParam
protected TaskParameterMetadata	authModeTaskParam
static java.lang.String	BLOCK_NAME_LOGINTASKDATA	The name of the Block that should contain the resulting task response.
protected TaskParameterMetadata	loginTaskParam
static java.lang.String	PARAM_NAME_APPLICATION_TYPE	The application type making the request.
static java.lang.String	PARAM_NAME_AUTH_MODE	The name of the authentication mode parameter.
static java.lang.String	PARAM_NAME_L	The name of the user ID parameter.
static java.lang.String	PARAM_NAME_LOGIN	Deprecated.
static java.lang.String	PARAM_NAME_P	The name of the password parameter.
static java.lang.String	PARAM_NAME_PASSWORD	Deprecated.
protected TaskParameterMetadata	passwordTaskParam
static java.lang.String	PROP_NAME_LOGINTASKDATA_SESSION_STATE	The name of the session ID property in the Block.

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

Modifier	Constructor	Description
	LoginFirstTask()	Creates a new LoginTask object.
protected	LoginFirstTask(java.lang.String desc)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	configure(Block block, TaskRequestContext context, WebAppSessionManager sessionManager)
TaskRequestContext	newRequestContext()	Returns a new object to hold per-request data for this Task.
void	processRequest(TaskRequestContext context, TaskOutput taskOutput)	The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the AbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput) version.

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_P

public static final java.lang.String PARAM_NAME_P

The name of the password parameter.

See Also:

Constant Field Values

PARAM_NAME_PASSWORD

@Deprecated
public static final java.lang.String PARAM_NAME_PASSWORD

Deprecated.

See Also:

Constant Field Values

PARAM_NAME_L

public static final java.lang.String PARAM_NAME_L

The name of the user ID parameter.

See Also:

Constant Field Values

PARAM_NAME_LOGIN

@Deprecated
public static final java.lang.String PARAM_NAME_LOGIN

Deprecated.

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

BLOCK_NAME_LOGINTASKDATA

public static final java.lang.String BLOCK_NAME_LOGINTASKDATA

The name of the Block that should contain the resulting task response.

See Also:

Constant Field Values

PROP_NAME_LOGINTASKDATA_SESSION_STATE

public static final java.lang.String PROP_NAME_LOGINTASKDATA_SESSION_STATE

The name of the session ID property in the Block.

See Also:

Constant Field Values

PARAM_NAME_APPLICATION_TYPE

public static final java.lang.String PARAM_NAME_APPLICATION_TYPE

The application type making the request.

See Also:

EnumDSSXMLApplicationType, Constant Field Values

loginTaskParam

protected TaskParameterMetadata loginTaskParam

passwordTaskParam

protected TaskParameterMetadata passwordTaskParam

authModeTaskParam

protected TaskParameterMetadata authModeTaskParam

applicationTypeTaskParam

protected TaskParameterMetadata applicationTypeTaskParam

Constructor Detail

LoginFirstTask

protected LoginFirstTask(java.lang.String desc)

LoginFirstTask

public LoginFirstTask()

Creates a new LoginTask object.

Method Detail

newRequestContext

public TaskRequestContext newRequestContext()

Description copied from interface: Task

Returns a new object to hold per-request data for this Task.

Specified by:

newRequestContext in interface Task

Overrides:

newRequestContext in class AbstractBaseTask

Returns:

A new TaskRequestContext object for this Task.

configure

protected java.lang.String configure(Block block,
                                     TaskRequestContext context,
                                     WebAppSessionManager sessionManager)
                              throws TaskException

Throws:

TaskException

processRequest

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

Description copied from class: AbstractBaseTask

The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the AbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput) version.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

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

taskOutput - The TaskOutput that contains the output generated by the Task.

Throws:

TaskException - If the Task was unable to satisfy the request.

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)