public interface

LoginForm

com.microstrategy.web.app.LoginForm
Known Indirect Subclasses

Summary

Public Methods
abstract 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.
abstract 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.
abstract 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.
abstract Locale getLocale()
Get the desired locale that the user is operating in
abstract String getLoginName()
Get the value of the Login name supplied by the user
abstract String getPassword()
Get the value of the Password supplied by the user
abstract String getProjectName()
Get the desired server project (if available)
abstract String getServerName()
Get the desired server name (if available)
abstract int getServerPort()
Get the desired server port (if available)
abstract WebIServerSession getWebIServerSession()
Get the WebIServerSession object that the Web Universal application would use by default.
abstract 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.
abstract 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.
abstract 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.
abstract void setLocale(Locale locale)
Set the desired locale that the user is operating in
abstract void setLoginName(String loginName)
Set the value of the Login name supplied by the user
abstract void setPassword(String password)
Set the value of the Password supplied by the user
abstract void setProjectName(String projectName)
Set the desired server project
abstract void setServerName(String serverName)
Set the desired server name
abstract void setServerPort(int serverPort)
Set the desired server port
abstract void setWebIServerSession(WebIServerSession session)
If the Form Status is true, then the External Security Provider can specify the WebIServerSession object to use.

Public Methods

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getPassword ()

Get the value of the Password supplied by the user

Returns
  • a String with the password given by the user

public abstract String getProjectName ()

Get the desired server project (if available)

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

public abstract String getServerName ()

Get the desired server name (if available)

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

public abstract int getServerPort ()

Get the desired server port (if available)

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

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract void setProjectName (String projectName)

Set the desired server project

Parameters
projectName String with the server project information

public abstract void setServerName (String serverName)

Set the desired server name

Parameters
serverName String with the server name information

public abstract void setServerPort (int serverPort)

Set the desired server port

Parameters
serverPort int with the server port information

public abstract 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.