public interface

LoginBean

implements AppComponent RequestPersistable
com.microstrategy.web.app.beans.LoginBean

Class Overview

This bean holds and display the required information for a user to log in to a project.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract int getAvailableAuthenticationModes()
Get the authentication modes enabled for the given server where the user is trying to connect to.
abstract int getAvailableWebLoginModes()
Get the web login modes enabled for the given server where the user is trying to connect to.
abstract int getDefaultAuthenticationMode()
Get the default authentication mode selected for the given server where the user is trying to connect to.
abstract int getDefaultWebLoginMode()
Get the default web login mode selected for the given server where the user is trying to connect to.
abstract int getLoginRequiredAuthenticationMode()
Get the authentication mode that is known to require more information to complete a valid login
abstract String getLoginRequiredKey()
Get the key of the session that is known to require more information to complete a valid login
abstract int getLoginRequiredPortNumber()
Get the port number that is known to require more information to complete a valid login
abstract String getLoginRequiredProjectName()
Get the project name that is known to require more information to complete a valid login
abstract String getLoginRequiredServerName()
Get the server name that is known to require more information to complete a valid login
abstract String getLoginRequiredUserName()
Get the user ID that is known to require more information to complete a valid login
abstract String getServerAlias()
Get the server alias that is known to require more information to complete a valid login
abstract RequestKeys getTargetRequestKeys()
Get the RequestKeys instance to be used for obtaining the target information on where the login bean should go after the login form is successfully submitted.
abstract boolean isConnectionInformationOnURL()
Get if the connection information should be passed on the URL once the login request is submitted by the user
abstract void setTargetRequestKeys(String targetUrl, boolean lateRestoreState)
Set the url information that will get the RequestKeys instance initialized, for knowing where the login bean should redirect the user once the login form is submitted successfully
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract int getAvailableAuthenticationModes ()

Get the authentication modes enabled for the given server where the user is trying to connect to.

Returns
  • a flag made up by EnumDSSXMLAuthModes values indicating which modes are enabled. If no server is specified, then the Administrator default setting value is returned.

public abstract int getAvailableWebLoginModes ()

Get the web login modes enabled for the given server where the user is trying to connect to.

Returns
  • a flag made up by EnumWebLoginModes values indicating which modes are enabled. If no server is specified, then the Administrator default setting value is returned.

public abstract int getDefaultAuthenticationMode ()

Get the default authentication mode selected for the given server where the user is trying to connect to.

Returns
  • an int value from EnumDSSXMLAuthModes indicating which mode is the default. If no server is specified, then the Administrator default setting value is returned.

public abstract int getDefaultWebLoginMode ()

Get the default web login mode selected for the given server where the user is trying to connect to.

Returns
  • an int value from EnumWebLoginModes indicating which mode is the default. If no server is specified, then the Administrator default setting value is returned.

public abstract int getLoginRequiredAuthenticationMode ()

Get the authentication mode that is known to require more information to complete a valid login

Returns
  • an int with an authentication mode value defined on EnumDSSXMLAuthModes. This value might come from previous information the user sent on a request.

public abstract String getLoginRequiredKey ()

Get the key of the session that is known to require more information to complete a valid login

Returns
  • a String with the session key. This value might come from previous information the user sent on a request. If nothing found, returns null

public abstract int getLoginRequiredPortNumber ()

Get the port number that is known to require more information to complete a valid login

Returns
  • an int with the number of the port. This value might come from previous information the user sent on a request. If nothing found, returns 0

public abstract String getLoginRequiredProjectName ()

Get the project name that is known to require more information to complete a valid login

Returns
  • a String with the project name. This value might come from previous information the user sent on a request. If nothing found, returns null

public abstract String getLoginRequiredServerName ()

Get the server name that is known to require more information to complete a valid login

Returns
  • a String with the server name. This value might come from previous information the user sent on a request. If nothing found, returns null

public abstract String getLoginRequiredUserName ()

Get the user ID that is known to require more information to complete a valid login

Returns
  • a String with the login ID name. This value might come from previous information the user sent on a request. If nothing found, returns null

public abstract String getServerAlias ()

Get the server alias that is known to require more information to complete a valid login

Returns
  • a String with the server alias. This value might come from previous information the user sent on a request. If nothing found, returns null

public abstract RequestKeys getTargetRequestKeys ()

Get the RequestKeys instance to be used for obtaining the target information on where the login bean should go after the login form is successfully submitted.

Returns
  • a RequestKeys instance with the information, if available.

public abstract boolean isConnectionInformationOnURL ()

Get if the connection information should be passed on the URL once the login request is submitted by the user

Returns
  • a boolean value according to the Administrator setting.

public abstract void setTargetRequestKeys (String targetUrl, boolean lateRestoreState)

Set the url information that will get the RequestKeys instance initialized, for knowing where the login bean should redirect the user once the login form is submitted successfully

Parameters
targetUrl String with the url information where to take the user after login.
lateRestoreState boolean value indicating if information for the target request keys comes from restore state or not.