Package com.microstrategy.web.app.transforms

Class LoginContinueTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.LoginContinueTransform

All Implemented Interfaces:

AppTransform, Transform

public class LoginContinueTransform
extends AbstractAppTransform

Title: LoginContinueTransform. This transform renders a form with a button for allowing the user to continue the login process for the requested Project and IServer. In most cases, the session might had already been established so this transform is mainly used together with another rendering process that could take care of displaying any pending messages to the user before s/he's allowed to continue. An example of the use of this transform is when there are missing licenses on the IServer and the user is alerted some functionality might not be available for the current login.

Since:

MicroStrategy Web 7.5.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

AbstractAppTransform.Context

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
LoginContinueTransform()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getArgumentName(WebEvent event, int argumentId)	Get the name of the argument assigned to the WebEvent, based on the indicated id.
java.lang.String	getDescription()	Returns the textual description of the transform
LoginBean	getLoginBean()	Get the LoginBean instance being transformed
protected WebEvent	getLoginEvent(LoginBean bean)	Generate the WebEvent instance to be used for login.
protected java.lang.String	getLoginEventFormAction(LoginBean bean, WebEvent event, int eventEnabled)	For the event to use for login, if the user has enabled to keep the information of the current session available on the URL, then we need to pass these details on the URL (form ACTION attribute) since otherwise users won't be able to bookmark the resulting page after login.
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
void	renderContinueDialog(MarkupOutput out, LoginBean bean)	Render the login dialog corresponding to this transform.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the graphical output for the Login Bean.
void	transformForRequestWaitingForUserInput(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestWaitingForUserInput, that is when the bean needs to answer prompts.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeTransform, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Constructor Detail

LoginContinueTransform

public LoginContinueTransform()

Default constructor. Initializes formal parameters.

Method Detail

getLoginBean

public LoginBean getLoginBean()

Get the LoginBean instance being transformed

Returns:

the current LoginBean instance being transformed

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Returns the supported bean type. This transform supports LoginBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

the class of the bean supported by this transform.

getDescription

public java.lang.String getDescription()

Returns the textual description of the transform

Returns:

the description of the transform

renderContinueDialog

public void renderContinueDialog(MarkupOutput out,
                                 LoginBean bean)

Render the login dialog corresponding to this transform. It will allow the user to continue with the login process given the credentials available from a previous request.

Parameters:

out - MarkupOutput instance where to save the contents to render

bean - LoginBean instance being transformed

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Generates the graphical output for the Login Bean. Internally, calls for the renderContinueDialog(MarkupOutput out, LoginBean bean) method.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - MarkupOutput instance where to create the HTML output

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

getLoginEvent

protected WebEvent getLoginEvent(LoginBean bean)

Generate the WebEvent instance to be used for login.

Parameters:

bean - LoginBean instance currently being transformed

Returns:

a WebEvent instance initialized with the information required for allowing users to login.

getLoginEventFormAction

protected java.lang.String getLoginEventFormAction(LoginBean bean,
                                                   WebEvent event,
                                                   int eventEnabled)

For the event to use for login, if the user has enabled to keep the information of the current session available on the URL, then we need to pass these details on the URL (form ACTION attribute) since otherwise users won't be able to bookmark the resulting page after login. We will enable this only when the event to execute after login is the one indicated by eventEnabled.

Parameters:

bean - LoginBean currently being transformed

event - WebEvent generated for enabling the user to log in

eventEnabled - int value indicating for which event we will be generating the form ACTION information. Usually EnumServletEvents.WebEventOpenDesktop

Returns:

a String with the information to use for the form ACTION attribute. null if none should be used - and the information shall be included as hidden inputs.

getArgumentName

protected java.lang.String getArgumentName(WebEvent event,
                                           int argumentId)

Get the name of the argument assigned to the WebEvent, based on the indicated id. This method can be overwritten with an event-argumentId mapping in case the original event defined on the application is customized.

Overrides:

getArgumentName in class AbstractAppTransform

Parameters:

event - WebEvent from where the argument name will be retrieved

argumentId - int with the identifier of the argument to search for on the event

Returns:

the corresponding name of the event for the specified id. If it is not found, it will return null.

transformForRequestWaitingForUserInput

public void transformForRequestWaitingForUserInput(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestWaitingForUserInput, that is when the bean needs to answer prompts. By default it just generates an error message.
Usually prompts are handled by a Prompts transform, the bean is responsible to delegate execution to this transform when prompts are open so reaching this method is actually considered an error.
Transforms that would like to generate customized error message for this scenario should extend this method.

Overrides:

transformForRequestWaitingForUserInput in class AbstractAppTransform

Parameters:

out - output by this transform

Since:

MicroStrategy Web 9.0.0

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)