Package com.microstrategy.web.app.beans
Interface LoginBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,Persistable
,RequestPersistable
,Transformable
,WebComponent
public interface LoginBean extends AppComponent, RequestPersistable
This bean holds and display the required information for a user to log in to a project.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getAvailableAuthenticationModes()
Get the authentication modes enabled for the given server where the user is trying to connect to.int
getAvailableWebLoginModes()
Get the web login modes enabled for the given server where the user is trying to connect to.int
getDefaultAuthenticationMode()
Get the default authentication mode selected for the given server where the user is trying to connect to.int
getDefaultWebLoginMode()
Get the default web login mode selected for the given server where the user is trying to connect to.int
getLoginRequiredAuthenticationMode()
Get the authentication mode that is known to require more information to complete a valid loginjava.lang.String
getLoginRequiredKey()
Get the key of the session that is known to require more information to complete a valid loginint
getLoginRequiredPortNumber()
Get the port number that is known to require more information to complete a valid loginjava.lang.String
getLoginRequiredProjectName()
Get the project name that is known to require more information to complete a valid loginjava.lang.String
getLoginRequiredServerName()
Get the server name that is known to require more information to complete a valid loginjava.lang.String
getLoginRequiredUserName()
Get the user ID that is known to require more information to complete a valid loginjava.lang.String
getServerAlias()
Get the server alias that is known to require more information to complete a valid loginRequestKeys
getTargetRequestKeys()
Get theRequestKeys
instance to be used for obtaining the target information on where the login bean should go after the login form is successfully submitted.boolean
isConnectionInformationOnURL()
Get if the connection information should be passed on the URL once the login request is submitted by the uservoid
setTargetRequestKeys(java.lang.String targetUrl, boolean lateRestoreState)
Set the url information that will get theRequestKeys
instance initialized, for knowing where the login bean should redirect the user once the login form is submitted successfully-
Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Method Detail
-
getLoginRequiredUserName
java.lang.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, returnsnull
-
getLoginRequiredPortNumber
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, returns0
-
getLoginRequiredServerName
java.lang.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, returnsnull
-
getServerAlias
java.lang.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, returnsnull
-
getLoginRequiredProjectName
java.lang.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, returnsnull
-
getLoginRequiredKey
java.lang.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, returnsnull
-
getLoginRequiredAuthenticationMode
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 onEnumDSSXMLAuthModes
. This value might come from previous information the user sent on a request.
-
getAvailableAuthenticationModes
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.
-
getAvailableWebLoginModes
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.
-
getDefaultAuthenticationMode
int getDefaultAuthenticationMode()
Get the default authentication mode selected for the given server where the user is trying to connect to.- Returns:
- an
int
value fromEnumDSSXMLAuthModes
indicating which mode is the default. If no server is specified, then the Administrator default setting value is returned.
-
getDefaultWebLoginMode
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 fromEnumWebLoginModes
indicating which mode is the default. If no server is specified, then the Administrator default setting value is returned.
-
isConnectionInformationOnURL
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.
-
getTargetRequestKeys
RequestKeys getTargetRequestKeys()
Get theRequestKeys
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.
-
setTargetRequestKeys
void setTargetRequestKeys(java.lang.String targetUrl, boolean lateRestoreState)
Set the url information that will get theRequestKeys
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.
-
-