Package com.microstrategy.web.app.tasks

Class AppLoginTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.LoginTask

com.microstrategy.web.app.tasks.AppLoginTask

All Implemented Interfaces:

Task

public class AppLoginTask
extends LoginTask

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAM_NAME_SET_AS_ACTIVE_SESSION
protected TaskParameterMetadata	setAsActiveSessionParam

Fields inherited from class com.microstrategy.web.tasks.LoginTask

applicationTypeTaskParam, authModeTaskParam, BLOCK_NAME_LOGINTASKDATA, loginTaskParam, PARAM_NAME_APPLICATION_TYPE, PARAM_NAME_AUTH_MODE, PARAM_NAME_L, PARAM_NAME_LOGIN, PARAM_NAME_P, PARAM_NAME_PASSWORD, PARAM_NAME_PORT, PARAM_NAME_PROJECT, PARAM_NAME_SERVER, PARAM_NAME_TWO_STEP_VERIFICATION_CODE, passwordTaskParam, portTaskParam, projectTaskParam, PROP_NAME_LOGINTASKDATA_NAME, PROP_NAME_LOGINTASKDATA_SESSION_STATE, serverTaskParam, tsvCodeTaskParam

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
AppLoginTask()

Method Summary

Modifier and Type	Method	Description
protected void	checkSession(TaskRequestContext context, WebIServerSession wiss)
protected java.lang.String	configure(Block block, TaskRequestContext context, WebIServerSession wiss)
protected void	configureWebIServerSession(TaskRequestContext context, WebIServerSession wiss, java.lang.String server, int port, java.lang.String project, java.lang.String l, java.lang.String p, int authMode, java.lang.String twoStepVerificationCode, java.lang.String accessToken)
protected java.lang.String	getAccessToken(TaskRequestContext trc)
protected boolean	isAuthModeEnabled(TaskRequestContext context, WebIServerSession session)
TaskRequestContext	newRequestContext()	Returns a new object to hold per-request data for this Task.
void	processRequest(TaskRequestContext context, TaskOutput taskOutput)	Creates an Intelligence Server session using the information supplied in the request.

Methods inherited from class com.microstrategy.web.tasks.LoginTask

buildResponse, checkAuthParameters, configureWebIServerSession, configureWebIServerSession

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_SET_AS_ACTIVE_SESSION

public static final java.lang.String PARAM_NAME_SET_AS_ACTIVE_SESSION

See Also:

Constant Field Values

setAsActiveSessionParam

protected TaskParameterMetadata setAsActiveSessionParam

Constructor Detail

AppLoginTask

public AppLoginTask()

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.

processRequest

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

Description copied from class: LoginTask

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

Specified by:

processRequest in interface Task

Overrides:

processRequest in class LoginTask

Parameters:

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

taskOutput - The TaskOutput 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, TaskOutput)

getAccessToken

protected java.lang.String getAccessToken(TaskRequestContext trc)

Overrides:

getAccessToken in class LoginTask

configureWebIServerSession

protected void configureWebIServerSession(TaskRequestContext context,
                                          WebIServerSession wiss,
                                          java.lang.String server,
                                          int port,
                                          java.lang.String project,
                                          java.lang.String l,
                                          java.lang.String p,
                                          int authMode,
                                          java.lang.String twoStepVerificationCode,
                                          java.lang.String accessToken)
                                   throws TaskException

Overrides:

configureWebIServerSession in class LoginTask

Throws:

TaskException

isAuthModeEnabled

protected boolean isAuthModeEnabled(TaskRequestContext context,
                                    WebIServerSession session)
                             throws TaskException

Overrides:

isAuthModeEnabled in class LoginTask

Throws:

TaskException

checkSession

protected void checkSession(TaskRequestContext context,
                            WebIServerSession wiss)
                     throws TaskException

Overrides:

checkSession in class LoginTask

Throws:

TaskException

configure

protected java.lang.String configure(Block block,
                                     TaskRequestContext context,
                                     WebIServerSession wiss)
                              throws TaskException

Overrides:

configure in class LoginTask

Throws:

TaskException