Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

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.

Interfaces

Classes

Exceptions

LoginBean

Class Overview

Summary

Public Methods

public abstract int getAvailableAuthenticationModes ()

Returns

public abstract int getAvailableWebLoginModes ()

Returns

public abstract int getDefaultAuthenticationMode ()

Returns

public abstract int getDefaultWebLoginMode ()

Returns

public abstract int getLoginRequiredAuthenticationMode ()

Returns

public abstract String getLoginRequiredKey ()

Returns

public abstract int getLoginRequiredPortNumber ()

Returns

public abstract String getLoginRequiredProjectName ()

Returns

public abstract String getLoginRequiredServerName ()

Returns

public abstract String getLoginRequiredUserName ()

Returns

public abstract String getServerAlias ()

Returns

public abstract RequestKeys getTargetRequestKeys ()

Returns

public abstract boolean isConnectionInformationOnURL ()

Returns

public abstract void setTargetRequestKeys (String targetUrl, boolean lateRestoreState)

Parameters