public class

MSTRLoginForm

extends Object
implements LoginForm
java.lang.Object
   ↳ com.microstrategy.web.app.MSTRLoginForm

Summary

Public Constructors
MSTRLoginForm()
Class Constructor
Public Methods
int getAuthMode()
Returns the current setting of the authMode property, which determines the type of credentials used upon creating a session to the Intelligence Server.
String getFormErrorMessage()
If the Form Status is false, then the External Security Provider can specify an error message for the Web Universal application to display.
boolean getFormStatus()
If the data supplied in the login form was successfully used to construct a WebIServerSession, then the External Security Provider set the Form Status to true.
Locale getLocale()
Get the desired locale that the user is operating in
String getLoginName()
Get the value of the Login name supplied by the user
String getPassword()
Get the value of the Password supplied by the user
String getProjectName()
Get the desired server project (if available)
String getServerName()
Get the desired server name (if available)
int getServerPort()
Get the desired server port (if available)
WebIServerSession getWebIServerSession()
Get the WebIServerSession object that the Web Universal application would use by default.
void setAuthMode(int authMode)
Sets the current setting of the authMode property, which determines the type of credentials used upon creating a session to the Intelligence Server.
void setFormErrorMessage(String errMsg)
If the Form Status is false, then the External Security Provider can specify an error message for the Web Universal application to display.
void setFormStatus(boolean status)
If the data supplied in the login form was successfully used to construct a WebIServerSession, then the External Security Provider should set the Form Status to true.
void setLocale(Locale locale)
Set the desired locale that the user is operating in
void setLoginName(String loginName)
Set the value of the Login name supplied by the user
void setPassword(String password)
Set the value of the Password supplied by the user
void setProjectName(String projectName)
Set the desired server project
void setServerName(String serverName)
Set the desired server name
void setServerPort(int serverPort)
Set the desired server port
void setWebIServerSession(WebIServerSession session)
If the Form Status is true, then the External Security Provider can specify the WebIServerSession object to use.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.app.LoginForm

Public Constructors

public MSTRLoginForm ()

Class Constructor

Public Methods

public int getAuthMode ()

Returns the current setting of the authMode property, which determines the type of credentials used upon creating a session to the Intelligence Server.

Returns
See Also

public String getFormErrorMessage ()

If the Form Status is false, then the External Security Provider can specify an error message for the Web Universal application to display.

Returns
  • String with the error message to assign. If no message is provided (null), then the Web Application can provide a generic error message.

public boolean getFormStatus ()

If the data supplied in the login form was successfully used to construct a WebIServerSession, then the External Security Provider set the Form Status to true. If there was an error in the form data or a WebIServerSession could not be constructed, then the External Security Provider set this value to false.

Returns
  • boolean indicating the form status to assign.

public Locale getLocale ()

Get the desired locale that the user is operating in

Returns
  • a Locale instance representing the locale the user has selected to work with

public String getLoginName ()

Get the value of the Login name supplied by the user

Returns
  • a String with the login name given by the user

public String getPassword ()

Get the value of the Password supplied by the user

Returns
  • a String with the password given by the user

public String getProjectName ()

Get the desired server project (if available)

Returns
  • a String with the server project information, if provided

public String getServerName ()

Get the desired server name (if available)

Returns
  • a String with the server name information, if provided

public int getServerPort ()

Get the desired server port (if available)

Returns
  • a int with the server port information, if provided

public WebIServerSession getWebIServerSession ()

Get the WebIServerSession object that the Web Universal application would use by default. This is constructed based on the values collected by the Web Application.

Returns
  • a WebIServerSession instance that the application should use for the current request

public void setAuthMode (int authMode)

Sets the current setting of the authMode property, which determines the type of credentials used upon creating a session to the Intelligence Server.

Parameters
authMode The authMode setting to use, from EnumDSSXMLAuthModes.
See Also

public void setFormErrorMessage (String errMsg)

If the Form Status is false, then the External Security Provider can specify an error message for the Web Universal application to display. If no message is provided (null), then the Web Application will provide a generic error message.

Parameters
errMsg String with the error message to assign.

public void setFormStatus (boolean status)

If the data supplied in the login form was successfully used to construct a WebIServerSession, then the External Security Provider should set the Form Status to true. If there was an error in the form data or a WebIServerSession could not be constructed, then the External Security Provider should set this value to false.

Parameters
status boolean indicating the form status to assign.

public void setLocale (Locale locale)

Set the desired locale that the user is operating in

Parameters
locale Locale instance representing the locale the user has selected to work with

public void setLoginName (String loginName)

Set the value of the Login name supplied by the user

Parameters
loginName String with the login name given by the user

public void setPassword (String password)

Set the value of the Password supplied by the user

Parameters
password String with the password given by the user

public void setProjectName (String projectName)

Set the desired server project

Parameters
projectName String with the server project information

public void setServerName (String serverName)

Set the desired server name

Parameters
serverName String with the server name information

public void setServerPort (int serverPort)

Set the desired server port

Parameters
serverPort int with the server port information

public void setWebIServerSession (WebIServerSession session)

If the Form Status is true, then the External Security Provider can specify the WebIServerSession object to use.

Parameters
session WebIServerSession instance to be used.