public class

LoginTransform

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.LoginTransform
Known Direct Subclasses

Class Overview

This transform renders the login dialog to the user, displaying the different options according to what the Administrator has marked as enabled for users given the IServer and Project selected.

Summary

Constants
String FP_IMAGE_LOW_LEFT_CORNER Name of the formal parameter that represents the image to be displayed at the bottom left corner of the login box.
String FP_IMAGE_LOW_RIGHT_CORNER Name of the formal parameter that represents the image to be displayed at the bottom right corner of the login box.
String FP_IMAGE_UP_LEFT_CORNER Name of the formal parameter that represents the image to be displayed at the top left corner of the login box.
String FP_IMAGE_UP_RIGHT_CORNER Name of the formal parameter that represents the image to be displayed at the top right corner of the login box.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter _fpImgLowLeft Indicates the image to be displayed at the bottom left corner of the login box.
public FormalParameter _fpImgLowRight Indicates the image to be displayed at the bottom right corner of the login box.
public FormalParameter _fpImgUpLeft Indicates the image to be displayed at the top left corner of the login box.
public FormalParameter _fpImgUpRight Indicates the image to be displayed at the top right corner of the login box.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
LoginTransform()
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 initializeImages()
Initialize the images to be used by this transform.
boolean isAutoCompleteEnabled()
Utility method to verify if autocomplete is enabled on login for security reasons
void renderGuestAuthenticationLink(MarkupOutput out, WebEvent event)
Render the link for guest authentication to show to users for log into a project
void renderLoginDialog(MarkupOutput out, LoginBean bean)
This method is deprecated. use renderLoginDialog(MarkupOutput) instead. The bean information will be calculated internally.
void renderLoginDialog(MarkupOutput out)
Render the actual login dialog.
void renderLoginDialogFooter(MarkupOutput out)
Render the footer in the table of the login dialog as an HTML TR element.
void renderLoginDialogFooter(MarkupOutput out, LoginBean bean)
This method is deprecated. use renderLoginDialogFooter(MarkupOutput) instead. The bean information will be calculated internally.
void renderLoginDialogHeader(MarkupOutput out)
Render the header in the table of the login dialog as an HTML TR element.
void renderLoginDialogHeader(MarkupOutput out, LoginBean bean)
This method is deprecated. use renderLoginDialogHeader(MarkupOutput) instead. The bean information will be calculated internally.
void renderNTGuestLoginSection(MarkupOutput out)
Generates the HTML to present the user with the options for logging into a project with NT and/or Guest authentication modes, according to what the Administrator enabled.
void renderNTGuestLoginSection(MarkupOutput out, LoginBean bean, WebEvent loginEvent, WebEvent cancelEvent)
This method is deprecated. use renderNTGuestLoginSection(MarkupOutput) instead. The bean and event information will be calculated internally.
void renderPortletWarning(MarkupOutput out)
void renderProjectSection(MarkupOutput out)
Render the project information available.
void renderSSPAuthenticationLink(MarkupOutput out, WebEvent event)
void renderServerSection(MarkupOutput out)
Render the server information available
void renderStandardLoginSection(MarkupOutput out, LoginBean bean, WebEvent loginEvent, WebEvent cancelEvent)
This method is deprecated. use renderLoginDialogFooter(MarkupOutput) instead. The bean and event information will be calculated internally.
void renderStandardLoginSection(MarkupOutput out)
Generates the HTML to present the user with the options for logging into a project with the authentication modes that require entering user name and password, according to what the Administrator enabled.
void renderWindowsAuthenticationLink(MarkupOutput out, WebEvent event)
Render the link for Windows (NT) authentication to show to users for log into a project
void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the Projects 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 getCancelEvent(LoginBean bean)
Generate the WebEvent instance to be used when users cancel the request to login.
WebEvent getHelpEvent(LoginBean bean)
Generate the WebEvent instance to be used when users requests for help when login.
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.
boolean isLoginFirst()
Utility method that determines if the environment currently defined by the administrator is set as login first.
[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

Constants

public static final String FP_IMAGE_LOW_LEFT_CORNER

Name of the formal parameter that represents the image to be displayed at the bottom left corner of the login box. Value is imgLowLeft.

Constant Value: "imgLowLeft"

public static final String FP_IMAGE_LOW_RIGHT_CORNER

Name of the formal parameter that represents the image to be displayed at the bottom right corner of the login box. Value is imgLowRight.

Constant Value: "imgLowRight"

public static final String FP_IMAGE_UP_LEFT_CORNER

Name of the formal parameter that represents the image to be displayed at the top left corner of the login box. Value is imgUpLeft.

Constant Value: "imgUpLeft"

public static final String FP_IMAGE_UP_RIGHT_CORNER

Name of the formal parameter that represents the image to be displayed at the top right corner of the login box. Value is imgUpRight.

Constant Value: "imgUpRight"

Fields

public FormalParameter _fpImgLowLeft

Indicates the image to be displayed at the bottom left corner of the login box. The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter. Users might want to customize the default value of this formal parameter if the background colors on the login dialog are changed since the default image represents a gray curved corner.

public FormalParameter _fpImgLowRight

Indicates the image to be displayed at the bottom right corner of the login box. The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter. Users might want to customize the default value of this formal parameter if the background colors on the login dialog are changed since the default image represents a gray curved corner.

public FormalParameter _fpImgUpLeft

Indicates the image to be displayed at the top left corner of the login box. The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter. Users might want to customize the default value of this formal parameter if the background colors on the login dialog are changed since the default image represents a gray curved corner.

public FormalParameter _fpImgUpRight

Indicates the image to be displayed at the top right corner of the login box. The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter. Users might want to customize the default value of this formal parameter if the background colors on the login dialog are changed since the default image represents a gray curved corner.

Public Constructors

public LoginTransform ()

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

Initialize the images to be used by this transform.

public boolean isAutoCompleteEnabled ()

Utility method to verify if autocomplete is enabled on login for security reasons

Returns
  • boolean value indicating if autocomplete is enabled according to the security settings.

public void renderGuestAuthenticationLink (MarkupOutput out, WebEvent event)

Render the link for guest authentication to show to users for log into a project

Parameters
out a MarkupOutput instance where to save the HTML to render
event a WebEvent instance with the details to be used when creating the link for this authentication mode

public void renderLoginDialog (MarkupOutput out, LoginBean bean)

This method is deprecated.
use renderLoginDialog(MarkupOutput) instead. The bean information will be calculated internally.

Render the actual login dialog. It will present the user the different login options depending on what the Administrator has enabled. The contents are rendered using an HTML TABLE for formatting purposes, controlling its width and number of columns based on the authentication modes enabled.

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

public void renderLoginDialog (MarkupOutput out)

Render the actual login dialog. It will present the user the different login options depending on what the Administrator has enabled. The contents are rendered using an HTML TABLE for formatting purposes, controlling its width and number of columns based on the authentication modes enabled.

Parameters
out MarkupOutput instance where to save the contents to render

public void renderLoginDialogFooter (MarkupOutput out)

Render the footer in the table of the login dialog as an HTML TR element. The cells to generate will depend on the login modes enabled. The parent TABLE should be opened beforehand (by default, renderLoginDialog takes care of that).

Parameters
out MarkupOutput instance where to save the contents to render

public void renderLoginDialogFooter (MarkupOutput out, LoginBean bean)

This method is deprecated.
use renderLoginDialogFooter(MarkupOutput) instead. The bean information will be calculated internally.

Render the footer in the table of the login dialog as an HTML TR element. The cells to generate will depend on the login modes enabled. The parent TABLE should be opened beforehand (by default, renderLoginDialog takes care of that).

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

public void renderLoginDialogHeader (MarkupOutput out)

Render the header in the table of the login dialog as an HTML TR element. The cells to generate will depend on the login modes enabled. The parent TABLE should be opened beforehand (by default, renderLoginDialog takes care of that).

Parameters
out MarkupOutput instance where to save the contents to render

public void renderLoginDialogHeader (MarkupOutput out, LoginBean bean)

This method is deprecated.
use renderLoginDialogHeader(MarkupOutput) instead. The bean information will be calculated internally.

Render the header in the table of the login dialog as an HTML TR element. The cells to generate will depend on the login modes enabled. The parent TABLE should be opened beforehand (by default, renderLoginDialog takes care of that).

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

public void renderNTGuestLoginSection (MarkupOutput out)

Generates the HTML to present the user with the options for logging into a project with NT and/or Guest authentication modes, according to what the Administrator enabled.

Parameters
out MarkupOutput instance where to save the contents to render

public void renderNTGuestLoginSection (MarkupOutput out, LoginBean bean, WebEvent loginEvent, WebEvent cancelEvent)

This method is deprecated.
use renderNTGuestLoginSection(MarkupOutput) instead. The bean and event information will be calculated internally.

Generates the HTML to present the user with the options for logging into a project with NT and/or Guest authentication modes, according to what the Administrator enabled.

Parameters
out MarkupOutput instance where to save the contents to render
bean LoginBean instance being transformed
loginEvent WebEvent to be used for logging the user in
cancelEvent WebEvent to be used if the user cancels the login request.

public void renderPortletWarning (MarkupOutput out)

public void renderProjectSection (MarkupOutput out)

Render the project information available.

Parameters
out a MarkupOutput instance where to save the HTML to render

public void renderSSPAuthenticationLink (MarkupOutput out, WebEvent event)

public void renderServerSection (MarkupOutput out)

Render the server information available

Parameters
out a MarkupOutput instance where to save the HTML to render

public void renderStandardLoginSection (MarkupOutput out, LoginBean bean, WebEvent loginEvent, WebEvent cancelEvent)

This method is deprecated.
use renderLoginDialogFooter(MarkupOutput) instead. The bean and event information will be calculated internally.

Generates the HTML to present the user with the options for logging into a project with the authentication modes that require entering user name and password, according to what the Administrator enabled. Typically, this will render Standard, Pass-Through and LDAP authentication modes.

Parameters
out MarkupOutput instance where to save the contents to render
bean LoginBean instance being transformed
loginEvent WebEvent to be used for logging the user in
cancelEvent WebEvent to be used if the user cancels the login request.

public void renderStandardLoginSection (MarkupOutput out)

Generates the HTML to present the user with the options for logging into a project with the authentication modes that require entering user name and password, according to what the Administrator enabled. Typically, this will render Standard, Pass-Through and LDAP authentication modes.

Parameters
out MarkupOutput instance where to save the contents to render

public void renderWindowsAuthenticationLink (MarkupOutput out, WebEvent event)

Render the link for Windows (NT) authentication to show to users for log into a project

Parameters
out a MarkupOutput instance where to save the HTML to render
event a WebEvent instance with the details to be used when creating the link for this authentication mode

public void transformForRequestSuccessful (MarkupOutput out)

Generates the graphical output for the Projects Bean

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 getCancelEvent (LoginBean bean)

Generate the WebEvent instance to be used when users cancel the request to login.

Parameters
bean LoginBean instance currently being transformed
Returns
  • a WebEvent instance initialized with the information required for allowing users to cancel the login. By default, if the environment is "login first" it will not return an event since going Home (default event returned) will only bring back the login page again.

protected WebEvent getHelpEvent (LoginBean bean)

Generate the WebEvent instance to be used when users requests for help when login.

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

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.

protected boolean isLoginFirst ()

Utility method that determines if the environment currently defined by the administrator is set as login first.

Returns
  • a boolean value indicating if the user should log in first before showing projects or not.