Package com.microstrategy.web.tasks

Class MobileLoginTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.LoginTask

com.microstrategy.web.tasks.MobileLoginTask

All Implemented Interfaces:

Task

Direct Known Subclasses:

MobileAppLoginTask

public class MobileLoginTask
extends LoginTask

Since:

MicroStrategy Web 8.1.1

Field Summary

Fields

Modifier and Type	Field	Description
protected TaskParameterMetadata	clientIDParam
protected TaskParameterMetadata	clientTypeParam
protected TaskParameterMetadata	defaultLocaleCountryParam
protected TaskParameterMetadata	defaultLocaleLanguageParam
protected TaskParameterMetadata	deviceIDParam
protected TaskParameterMetadata	displayLocaleOverrideParam
protected TaskParameterMetadata	displayLocaleParam
protected TaskParameterMetadata	includeStatsSettingsParam
protected TaskParameterMetadata	includeUserInfoParam
protected TaskParameterMetadata	localeCountryParam
protected TaskParameterMetadata	localeLanguageParam
protected TaskParameterMetadata	messagesLocaleOverrideParam
protected TaskParameterMetadata	messagesLocaleParam
protected TaskParameterMetadata	metadataLocaleOverrideParam
protected TaskParameterMetadata	metadataLocaleParam
protected TaskParameterMetadata	numberLocaleOverrideParam
protected TaskParameterMetadata	numberLocaleParam
static java.lang.String	PARAM_NAME_CLIENT_ID
static java.lang.String	PARAM_NAME_CLIENT_TYPE
static java.lang.String	PARAM_NAME_DEFAULT_LOCALE_COUNTRY
static java.lang.String	PARAM_NAME_DEFAULT_LOCALE_LANGUAGE
static java.lang.String	PARAM_NAME_DEVICE_ID
static java.lang.String	PARAM_NAME_INCLUDE_STATS_SETTINGS
static java.lang.String	PARAM_NAME_LOCALE_COUNTRY
static java.lang.String	PARAM_NAME_LOCALE_LANGUAGE
static java.lang.String	PARAM_NAME_PROJECT_ID	The ID of the project parameter.
static java.lang.String	PARAM_NAME_SESSION_FLAGS
static java.lang.String	PARAM_NAME_SESSION_KEY
static java.lang.String	PARAM_NAME_TIME_ZONE
static java.lang.String	PARAM_NAME_WORKING_SET_SIZE
protected TaskParameterMetadata	projectIDTaskParam
static java.lang.String	PROP_NAME_LOGINTASKDATA_OLD_SESSION_STATE	Deprecated. Replaced by LoginTask.PROP_NAME_LOGINTASKDATA_SESSION_STATE
protected TaskParameterMetadata	sessionFlagsParam
protected TaskParameterMetadata	sessionKeyParam
protected TaskParameterMetadata	timeZoneParam
protected TaskParameterMetadata	warehouseDataLocaleOverrideParam
protected TaskParameterMetadata	warehouseDataLocaleParam
protected TaskParameterMetadata	workingSetSizeParam

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

Method Summary

Modifier and Type	Method	Description
protected void	addVersionInfo(Block block, WebIServerSession wiss)
protected void	checkSession(TaskRequestContext context, WebIServerSession wiss)
protected void	checkSession(TaskRequestContext context, WebIServerSession wiss, boolean skipCheck)
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 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, java.lang.String orgID)
protected boolean	isAuthModeEnabled(WebIServerSession session)

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

buildResponse, checkAuthParameters, configureWebIServerSession, getAccessToken, isAuthModeEnabled, 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

Field Detail

PARAM_NAME_CLIENT_ID

public static final java.lang.String PARAM_NAME_CLIENT_ID

See Also:

Constant Field Values

PARAM_NAME_LOCALE_LANGUAGE

public static final java.lang.String PARAM_NAME_LOCALE_LANGUAGE

See Also:

Constant Field Values

PARAM_NAME_LOCALE_COUNTRY

public static final java.lang.String PARAM_NAME_LOCALE_COUNTRY

See Also:

Constant Field Values

PARAM_NAME_DEFAULT_LOCALE_LANGUAGE

public static final java.lang.String PARAM_NAME_DEFAULT_LOCALE_LANGUAGE

See Also:

Constant Field Values

PARAM_NAME_DEFAULT_LOCALE_COUNTRY

public static final java.lang.String PARAM_NAME_DEFAULT_LOCALE_COUNTRY

See Also:

Constant Field Values

PARAM_NAME_TIME_ZONE

public static final java.lang.String PARAM_NAME_TIME_ZONE

See Also:

Constant Field Values

PARAM_NAME_WORKING_SET_SIZE

public static final java.lang.String PARAM_NAME_WORKING_SET_SIZE

See Also:

Constant Field Values

PARAM_NAME_SESSION_KEY

public static final java.lang.String PARAM_NAME_SESSION_KEY

See Also:

Constant Field Values

PARAM_NAME_DEVICE_ID

public static final java.lang.String PARAM_NAME_DEVICE_ID

See Also:

Constant Field Values

PARAM_NAME_INCLUDE_STATS_SETTINGS

public static final java.lang.String PARAM_NAME_INCLUDE_STATS_SETTINGS

See Also:

Constant Field Values

PARAM_NAME_SESSION_FLAGS

public static final java.lang.String PARAM_NAME_SESSION_FLAGS

See Also:

Constant Field Values

PARAM_NAME_CLIENT_TYPE

public static final java.lang.String PARAM_NAME_CLIENT_TYPE

See Also:

Constant Field Values

PROP_NAME_LOGINTASKDATA_OLD_SESSION_STATE

public static final java.lang.String PROP_NAME_LOGINTASKDATA_OLD_SESSION_STATE

Deprecated.

Replaced by LoginTask.PROP_NAME_LOGINTASKDATA_SESSION_STATE

This return tag is only included for backwards compatibility.

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

PARAM_NAME_PROJECT_ID

public static final java.lang.String PARAM_NAME_PROJECT_ID

The ID of the project parameter.

See Also:

Constant Field Values

clientIDParam

protected TaskParameterMetadata clientIDParam

localeLanguageParam

protected TaskParameterMetadata localeLanguageParam

localeCountryParam

protected TaskParameterMetadata localeCountryParam

defaultLocaleLanguageParam

protected TaskParameterMetadata defaultLocaleLanguageParam

defaultLocaleCountryParam

protected TaskParameterMetadata defaultLocaleCountryParam

timeZoneParam

protected TaskParameterMetadata timeZoneParam

workingSetSizeParam

protected TaskParameterMetadata workingSetSizeParam

metadataLocaleParam

protected TaskParameterMetadata metadataLocaleParam

Since:

MicroStrategy Web 9.0.0

metadataLocaleOverrideParam

protected TaskParameterMetadata metadataLocaleOverrideParam

Since:

MicroStrategy Web 9.0.0

displayLocaleParam

protected TaskParameterMetadata displayLocaleParam

Since:

MicroStrategy Web 9.0.0

displayLocaleOverrideParam

protected TaskParameterMetadata displayLocaleOverrideParam

Since:

MicroStrategy Web 9.0.0

messagesLocaleParam

protected TaskParameterMetadata messagesLocaleParam

Since:

MicroStrategy Web 9.0.0

messagesLocaleOverrideParam

protected TaskParameterMetadata messagesLocaleOverrideParam

Since:

MicroStrategy Web 9.0.0

numberLocaleParam

protected TaskParameterMetadata numberLocaleParam

Since:

MicroStrategy Web 9.0.0

numberLocaleOverrideParam

protected TaskParameterMetadata numberLocaleOverrideParam

Since:

MicroStrategy Web 9.0.0

warehouseDataLocaleParam

protected TaskParameterMetadata warehouseDataLocaleParam

Since:

MicroStrategy Web 9.0.0

warehouseDataLocaleOverrideParam

protected TaskParameterMetadata warehouseDataLocaleOverrideParam

Since:

MicroStrategy Web 9.0.0

includeUserInfoParam

protected TaskParameterMetadata includeUserInfoParam

Since:

MicroStrategy Web 9.0.1

sessionKeyParam

protected TaskParameterMetadata sessionKeyParam

deviceIDParam

protected TaskParameterMetadata deviceIDParam

includeStatsSettingsParam

protected TaskParameterMetadata includeStatsSettingsParam

sessionFlagsParam

protected TaskParameterMetadata sessionFlagsParam

clientTypeParam

protected TaskParameterMetadata clientTypeParam

projectIDTaskParam

protected TaskParameterMetadata projectIDTaskParam

Constructor Detail

MobileLoginTask

public MobileLoginTask()

Method Detail

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

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,
                                          java.lang.String orgID)
                                   throws TaskException

Overrides:

configureWebIServerSession 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

addVersionInfo

protected void addVersionInfo(Block block,
                              WebIServerSession wiss)

checkSession

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

Overrides:

checkSession in class LoginTask

Throws:

TaskException

checkSession

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

Throws:

TaskException

isAuthModeEnabled

protected boolean isAuthModeEnabled(WebIServerSession session)