Package com.microstrategy.web.app.tasks

Class UsherRegisterUserTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.LoginTask

com.microstrategy.web.app.tasks.UsherRegisterUserTask

All Implemented Interfaces:

EnumUsherRequest, Task

public class UsherRegisterUserTask
extends LoginTask
implements EnumUsherRequest

Field Summary

Fields

Modifier and Type	Field	Description
static int	DISABLE_USHER_REGISTRATION
static int	ENABLE_USHER_REGISTRATION
static java.lang.String	PARAM_NAME_EMAIL
static int	USE_ISERVER_USEREMAIL_REGISTRATION
static java.lang.String	USHER_REGISTRATION_OPTIONS

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

Fields inherited from interface com.microstrategy.web.app.utils.usher.EnumUsherRequest

BAD_CONFIG, CUSTOMER_USHER_APP_ID, GENERIC_ERROR_CODE_FOR_USHER_AUTH, HANDLE_INPUT_STREAM, HANDLE_STRING, INVALID_RESPONSE_FROM_USHER, INVALID_TOKEN, ORG_ID, SESSION_ID, TIME_TO_LIVE, USER_ALREADY_EXISTS, USHER_ACCESS_TOKEN

Constructor Summary

Constructors

Constructor	Description
UsherRegisterUserTask()

Method Summary

Modifier and Type	Method	Description
protected void	checkAuthParameters(java.lang.String server, int port, java.lang.String project, java.lang.String l, java.lang.String p, int authMode)	Ensures various authentication parameters are correctly configured, such as validating the server name is not an empty string.
protected void	checkSession(TaskRequestContext context, WebIServerSession wiss)
protected java.lang.String	configure(Block block, TaskRequestContext context, WebIServerSession wiss)
protected void	configureWebIServerSession(TaskRequestContext trc, 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 twoStepCode, java.lang.String accessToken)
void	processRequest(TaskRequestContext trc, TaskOutput taskOutput)	Creates an Intelligence Server session using the information supplied in the request.

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

buildResponse, configureWebIServerSession, configureWebIServerSession, getAccessToken, isAuthModeEnabled

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_EMAIL

public static final java.lang.String PARAM_NAME_EMAIL

See Also:

Constant Field Values

USHER_REGISTRATION_OPTIONS

public static final java.lang.String USHER_REGISTRATION_OPTIONS

See Also:

Constant Field Values

DISABLE_USHER_REGISTRATION

public static final int DISABLE_USHER_REGISTRATION

See Also:

Constant Field Values

ENABLE_USHER_REGISTRATION

public static final int ENABLE_USHER_REGISTRATION

See Also:

Constant Field Values

USE_ISERVER_USEREMAIL_REGISTRATION

public static final int USE_ISERVER_USEREMAIL_REGISTRATION

See Also:

Constant Field Values

Constructor Detail

UsherRegisterUserTask

public UsherRegisterUserTask()

Method Detail

processRequest

public void processRequest(TaskRequestContext trc,
                           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:

trc - 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)

checkAuthParameters

protected void checkAuthParameters(java.lang.String server,
                                   int port,
                                   java.lang.String project,
                                   java.lang.String l,
                                   java.lang.String p,
                                   int authMode)
                            throws TaskException

Description copied from class: LoginTask

Ensures various authentication parameters are correctly configured, such as validating the server name is not an empty string.

Overrides:

checkAuthParameters in class LoginTask

Throws:

TaskException - thrown if parameters fails this preliminary authentication check.

configure

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

Overrides:

configure in class LoginTask

Throws:

TaskException

checkSession

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

Overrides:

checkSession in class LoginTask

Throws:

TaskException

configureWebIServerSession

protected void configureWebIServerSession(TaskRequestContext trc,
                                          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 twoStepCode,
                                          java.lang.String accessToken)
                                   throws TaskException

Overrides:

configureWebIServerSession in class LoginTask

Throws:

TaskException