public class

LoginXHTMLTransform

extends LoginTransform
implements LayoutTransform
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
           ↳ com.microstrategy.web.app.transforms.LoginXHTMLTransform

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. It extends the LoginTransform by generating well-formed XHTML, supporting layout-xml, and using external css files for all formatting.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.LoginTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.LoginTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
LoginXHTMLTransform()
Default constructor, initializes formal parameters.
Public Methods
void renderCancelButton(MarkupOutput out)
Generates the HTML output for displaying a Cancel button to the user for cancelling the login request.
void renderFacebookAuthenticationLink(MarkupOutput out, WebEvent event)
void renderGuestAuthenticationLink(MarkupOutput out, WebEvent event)
Render the link for guest authentication to show to users for log into a project.
void renderKerberosAuthenticationLink(MarkupOutput out, WebEvent event)
Render the link for Kerberos authentication to show to users for log into a project.
void renderLoginButton(MarkupOutput out)
Generates the HTML to present the user with the button for submitting a login request.
void renderLoginDialog(MarkupOutput out)
Render the actual login dialog.
void renderLoginDialogFooter(MarkupOutput out)
Render the footer for the login dialog box.
void renderLoginDialogHeader(MarkupOutput out)
Render the header for the login dialog box.
void renderLoginModeToggle(MarkupOutput out)
void renderNTGuestLoginSection(MarkupOutput out)
Generates the HTML to present the user with the options for logging into a project with NT and/or Guest and/or Kerberos authentication modes, according to what the Administrator enabled.
void renderPassword(LoginBean bean, WebEvent loginEvent, Tag divTag)
void renderSSPAuthenticationLink(MarkupOutput out, WebEvent event)
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 renderTwoStepVerificationCodeOption(WebEvent loginEvent, Tag divTag, boolean visible)
void renderUserName(LoginBean bean, WebEvent loginEvent, Tag auxDivTag)
void renderUsherLogin(MarkupOutput out)
responsible for rendering the html where the QR code will be loaded by the Javascript
void renderUsherLoginHiddenForm(MarkupOutput out, WebEvent event)
Generate usher login form
void renderUsherLoginPlaceholder(MarkupOutput out)
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 LoginBean instance being transformed, when it's state is WebBeanRequestSuccessful.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes according to the event provided.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.LoginTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public LoginXHTMLTransform ()

Default constructor, initializes formal parameters.

Public Methods

public void renderCancelButton (MarkupOutput out)

Generates the HTML output for displaying a Cancel button to the user for cancelling the login request.

Parameters
out MarkupOutput instance where to save the contents to render

public void renderFacebookAuthenticationLink (MarkupOutput out, WebEvent event)

public void renderGuestAuthenticationLink (MarkupOutput out, WebEvent event)

Render the link for guest authentication to show to users for log into a project. Overwrites the parent method by generating the information as a FORM with a button with the information for submitting a guest authentication request.

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 renderKerberosAuthenticationLink (MarkupOutput out, WebEvent event)

Render the link for Kerberos 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 renderLoginButton (MarkupOutput out)

Generates the HTML to present the user with the button for submitting a login request.

Parameters
out MarkupOutput instance where to save the contents to render

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. Overwrites the parent method by generating the output as a series of DIV, SPAN and other HTML tags instead of contents of a table.

Parameters
out MarkupOutput instance where to save the contents to render

public void renderLoginDialogFooter (MarkupOutput out)

Render the footer for the login dialog box. Overwrites the parent method by not rendering any information.

Parameters
out MarkupOutput instance where to save the contents to render

public void renderLoginDialogHeader (MarkupOutput out)

Render the header for the login dialog box. Overwrites the parent method by generating the output as a series of DIV and SPAN HTML tags instead of contents of a table.

Parameters
out MarkupOutput instance where to save the contents to render

public void renderLoginModeToggle (MarkupOutput out)

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 and/or Kerberos authentication modes, according to what the Administrator enabled. Overwrites the parent method by generating the output as a series of DIV, SPAN and other HTML tags instead of contents of a table.

Parameters
out MarkupOutput instance where to save the contents to render

public void renderPassword (LoginBean bean, WebEvent loginEvent, Tag divTag)

public void renderSSPAuthenticationLink (MarkupOutput out, WebEvent event)

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. Overwrites the parent method by generating the output as a series of DIV, SPAN and other HTML tags instead of contents of a table.

Parameters
out MarkupOutput instance where to save the contents to render

public void renderTwoStepVerificationCodeOption (WebEvent loginEvent, Tag divTag, boolean visible)

public void renderUserName (LoginBean bean, WebEvent loginEvent, Tag auxDivTag)

public void renderUsherLogin (MarkupOutput out)

responsible for rendering the html where the QR code will be loaded by the Javascript

public void renderUsherLoginHiddenForm (MarkupOutput out, WebEvent event)

Generate usher login form

public void renderUsherLoginPlaceholder (MarkupOutput out)

public void renderWindowsAuthenticationLink (MarkupOutput out, WebEvent event)

Render the link for Windows (NT) authentication to show to users for log into a project. Overwrites the parent method by generating the information as a FORM with a button with the information for submitting a windows authentication request.

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 LoginBean instance being transformed, when it's state is WebBeanRequestSuccessful.

Parameters
out MarkupOutput instance where to create the HTML output

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes according to the event provided.

Parameters
event WebEvent instance with the information from where the anchor will be created
Returns
  • an AnchorTag instance initialized with the information from the event for enabling the user to submit a request.