Package com.microstrategy.web.app

Class MSTRLoginForm

  • All Implemented Interfaces:
    LoginForm
    public class MSTRLoginForm
extends java.lang.Object
implements LoginForm
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Constructor Summary

      Constructors 
      Constructor Description
      MSTRLoginForm()
      Class Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.
      java.lang.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.
      java.util.Locale getLocale()
      Get the desired locale that the user is operating in
      java.lang.String getLoginName()
      Get the value of the Login name supplied by the user
      java.lang.String getPassword()
      Get the value of the Password supplied by the user
      java.lang.String getProjectName()
      Get the desired server project (if available)
      java.lang.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​(java.lang.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​(java.util.Locale locale)
      Set the desired locale that the user is operating in
      void setLoginName​(java.lang.String lName)
      Set the value of the Login name supplied by the user
      void setPassword​(java.lang.String p)
      Set the value of the Password supplied by the user
      void setProjectName​(java.lang.String projectName)
      Set the desired server project
      void setServerName​(java.lang.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.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MSTRLoginForm

        public MSTRLoginForm()
        Class Constructor

    • Method Detail

      • getLoginName

        public java.lang.String getLoginName()
        Get the value of the Login name supplied by the user
        Specified by:
        getLoginName in interface LoginForm
        Returns:
        a String with the login name given by the user

      • getPassword

        public java.lang.String getPassword()
        Get the value of the Password supplied by the user
        Specified by:
        getPassword in interface LoginForm
        Returns:
        a String with the password given by the user

      • getServerName

        public java.lang.String getServerName()
        Get the desired server name (if available)
        Specified by:
        getServerName in interface LoginForm
        Returns:
        a String with the server name information, if provided

      • getServerPort

        public int getServerPort()
        Get the desired server port (if available)
        Specified by:
        getServerPort in interface LoginForm
        Returns:
        a int with the server port information, if provided

      • getProjectName

        public java.lang.String getProjectName()
        Get the desired server project (if available)
        Specified by:
        getProjectName in interface LoginForm
        Returns:
        a String with the server project information, if provided

      • getLocale

        public java.util.Locale getLocale()
        Get the desired locale that the user is operating in
        Specified by:
        getLocale in interface LoginForm
        Returns:
        a Locale instance representing the locale the user has selected to work with

      • getAuthMode

        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.
        Specified by:
        getAuthMode in interface LoginForm
        Returns:
        The current authMode setting, from EnumDSSXMLAuthModes.
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        setAuthMode(int)

      • getWebIServerSession

        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.
        Specified by:
        getWebIServerSession in interface LoginForm
        Returns:
        a WebIServerSession instance that the application should use for the current request

      • setFormStatus

        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.
        Specified by:
        setFormStatus in interface LoginForm
        Parameters:
        status - boolean indicating the form status to assign.

      • setFormErrorMessage

        public void setFormErrorMessage​(java.lang.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.
        Specified by:
        setFormErrorMessage in interface LoginForm
        Parameters:
        errMsg - String with the error message to assign.

      • setWebIServerSession

        public void setWebIServerSession​(WebIServerSession session)
        If the Form Status is true, then the External Security Provider can specify the WebIServerSession object to use.
        Specified by:
        setWebIServerSession in interface LoginForm
        Parameters:
        session - WebIServerSession instance to be used.

      • setLoginName

        public void setLoginName​(java.lang.String lName)
        Set the value of the Login name supplied by the user
        Specified by:
        setLoginName in interface LoginForm
        Parameters:
        lName - String with the login name given by the user

      • setPassword

        public void setPassword​(java.lang.String p)
        Set the value of the Password supplied by the user
        Specified by:
        setPassword in interface LoginForm
        Parameters:
        p - String with the password given by the user

      • setServerName

        public void setServerName​(java.lang.String serverName)
        Set the desired server name
        Specified by:
        setServerName in interface LoginForm
        Parameters:
        serverName - String with the server name information

      • setServerPort

        public void setServerPort​(int serverPort)
        Set the desired server port
        Specified by:
        setServerPort in interface LoginForm
        Parameters:
        serverPort - int with the server port information

      • setProjectName

        public void setProjectName​(java.lang.String projectName)
        Set the desired server project
        Specified by:
        setProjectName in interface LoginForm
        Parameters:
        projectName - String with the server project information

      • setAuthMode

        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.
        Specified by:
        setAuthMode in interface LoginForm
        Parameters:
        authMode - The authMode setting to use, from EnumDSSXMLAuthModes.
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        getAuthMode()

      • setLocale

        public void setLocale​(java.util.Locale locale)
        Set the desired locale that the user is operating in
        Specified by:
        setLocale in interface LoginForm
        Parameters:
        locale - Locale instance representing the locale the user has selected to work with

      • getFormStatus

        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.
        Specified by:
        getFormStatus in interface LoginForm
        Returns:
        boolean indicating the form status to assign.

      • getFormErrorMessage

        public java.lang.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.
        Specified by:
        getFormErrorMessage in interface LoginForm
        Returns:
        String with the error message to assign. If no message is provided (null), then the Web Application can provide a generic error message.