public class

LoginContinueTransform

extends AbstractAppTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.LoginContinueTransform

Class Overview

Title: LoginContinueTransform. This transform renders a form with a button for allowing the user to continue the login process for the requested Project and IServer. In most cases, the session might had already been established so this transform is mainly used together with another rendering process that could take care of displaying any pending messages to the user before s/he's allowed to continue. An example of the use of this transform is when there are missing licenses on the IServer and the user is alerted some functionality might not be available for the current login.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
LoginContinueTransform()
Default constructor.
Public Methods
String getDescription()
Returns the textual description of the transform
LoginBean getLoginBean()
Get the LoginBean instance being transformed
Class getSupportedBeanType()
Returns the supported bean type.
void renderContinueDialog(MarkupOutput out, LoginBean bean)
Render the login dialog corresponding to this transform.
void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the Login Bean.
void transformForRequestWaitingForUserInput(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestWaitingForUserInput, that is when the bean needs to answer prompts.
Protected Methods
String getArgumentName(WebEvent event, int argumentId)
Get the name of the argument assigned to the WebEvent, based on the indicated id.
WebEvent getLoginEvent(LoginBean bean)
Generate the WebEvent instance to be used for login.
String getLoginEventFormAction(LoginBean bean, WebEvent event, int eventEnabled)
For the event to use for login, if the user has enabled to keep the information of the current session available on the URL, then we need to pass these details on the URL (form ACTION attribute) since otherwise users won't be able to bookmark the resulting page after login.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public LoginContinueTransform ()

Default constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public LoginBean getLoginBean ()

Get the LoginBean instance being transformed

Returns
  • the current LoginBean instance being transformed

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports LoginBean instances

Returns
  • the class of the bean supported by this transform.

public void renderContinueDialog (MarkupOutput out, LoginBean bean)

Render the login dialog corresponding to this transform. It will allow the user to continue with the login process given the credentials available from a previous request.

Parameters
out MarkupOutput instance where to save the contents to render
bean LoginBean instance being transformed

public void transformForRequestSuccessful (MarkupOutput out)

Generates the graphical output for the Login Bean. Internally, calls for the renderContinueDialog(MarkupOutput, LoginBean) method.

Parameters
out MarkupOutput instance where to create the HTML output

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestWaitingForUserInput, that is when the bean needs to answer prompts. By default it just generates an error message.
Usually prompts are handled by a Prompts transform, the bean is responsible to delegate execution to this transform when prompts are open so reaching this method is actually considered an error.
Transforms that would like to generate customized error message for this scenario should extend this method.

Parameters
out output by this transform

Protected Methods

protected String getArgumentName (WebEvent event, int argumentId)

Get the name of the argument assigned to the WebEvent, based on the indicated id. This method can be overwritten with an event-argumentId mapping in case the original event defined on the application is customized.

Parameters
event WebEvent from where the argument name will be retrieved
argumentId int with the identifier of the argument to search for on the event
Returns
  • the corresponding name of the event for the specified id. If it is not found, it will return null.

protected WebEvent getLoginEvent (LoginBean bean)

Generate the WebEvent instance to be used for login.

Parameters
bean LoginBean instance currently being transformed
Returns
  • a WebEvent instance initialized with the information required for allowing users to login.

protected String getLoginEventFormAction (LoginBean bean, WebEvent event, int eventEnabled)

For the event to use for login, if the user has enabled to keep the information of the current session available on the URL, then we need to pass these details on the URL (form ACTION attribute) since otherwise users won't be able to bookmark the resulting page after login. We will enable this only when the event to execute after login is the one indicated by eventEnabled.

Parameters
bean LoginBean currently being transformed
event WebEvent generated for enabling the user to log in
eventEnabled int value indicating for which event we will be generating the form ACTION information. Usually WebEventOpenDesktop
Returns
  • a String with the information to use for the form ACTION attribute. null if none should be used - and the information shall be included as hidden inputs.