Package com.microstrategy.web.app

Interface LoginForm

  • All Known Implementing Classes:
    MSTRLoginForm
    public interface LoginForm
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract 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.

    • Method Detail

      • getLoginName

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

      • getPassword

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

      • getServerName

        java.lang.String getServerName()
        Get the desired server name (if available)
        Returns:
        a String with the server name information, if provided

      • getServerPort

        int getServerPort()
        Get the desired server port (if available)
        Returns:
        a int with the server port information, if provided

      • getProjectName

        java.lang.String getProjectName()
        Get the desired server project (if available)
        Returns:
        a String with the server project information, if provided

      • getLocale

        java.util.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

      • getAuthMode

        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:
        The current authMode setting, from EnumDSSXMLAuthModes.
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        setAuthMode(int)

      • getWebIServerSession

        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

      • setFormStatus

        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.

      • setFormErrorMessage

        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.
        Parameters:
        errMsg - String with the error message to assign.

      • setWebIServerSession

        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.

      • setLoginName

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

      • setPassword

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

      • setServerName

        void setServerName​(java.lang.String serverName)
        Set the desired server name
        Parameters:
        serverName - String with the server name information

      • setServerPort

        void setServerPort​(int serverPort)
        Set the desired server port
        Parameters:
        serverPort - int with the server port information

      • setProjectName

        void setProjectName​(java.lang.String projectName)
        Set the desired server project
        Parameters:
        projectName - String with the server project information

      • setLocale

        void setLocale​(java.util.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

      • setAuthMode

        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.
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        getAuthMode()

      • getFormStatus

        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.

      • getFormErrorMessage

        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.
        Returns:
        String with the error message to assign. If no message is provided (null), then the Web Application can provide a generic error message.