Package com.microstrategy.web.admin.transforms

Class UsherConfigTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.admin.transforms.AbstractAdminTransform

com.microstrategy.web.admin.transforms.AbstractServerPropertiesTransform

com.microstrategy.web.admin.transforms.UsherConfigTransform

All Implemented Interfaces:

AppTransform, Transform

public class UsherConfigTransform
extends AbstractServerPropertiesTransform

Since:

MicroStrategy Web 9.0.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.admin.transforms.AbstractServerPropertiesTransform

_adminBean, _imgUpperLeftCorner, _imgUpperRightCorner, _msgs, cancelEvent, cssHeaderTable, cssHR, cssInvalidPropertyName, cssMainTable, cssMainTableHeading, cssPropertyName, cssPropertyValue, cssSubHeading, cssSubmitButton, cssValuesTable, deleteEvent, FP_UPPER_LEFT_CORNER_IMAGE, FP_UPPER_RIGHT_CORNER_IMAGE, prefs, upperLeftCorner, upperRightCorner

Fields inherited from class com.microstrategy.web.admin.transforms.AbstractAdminTransform

needToUpdateStyleForDoubleByte

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
UsherConfigTransform()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getImportUsherUserFromSettings(java.util.Map<java.lang.Integer,java.lang.String> settings)
protected WebEvent	getSaveConnectEvent()
java.lang.String	getSecondFactorFromSettings(java.util.Map<java.lang.Integer,java.lang.String> settings)
protected java.lang.String	getTitle()
java.lang.String	getUserRegistrationEmailDomainFromSettings(java.util.Map<java.lang.Integer,java.lang.String> settings)
java.lang.String	getUserRegistrationOptionFromSettings(java.util.Map<java.lang.Integer,java.lang.String> settings)
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
boolean	isAutoCompleteEnabled()
protected void	renderImportUsherUserOption(MarkupOutput out, java.util.Map<java.lang.Integer,java.lang.String> settings)
protected void	renderLoginInfo(MarkupOutput out, java.util.Map<java.lang.Integer,java.lang.String> settings)
protected void	renderServerError(MarkupOutput out)
protected void	renderTextField(MarkupOutput out, java.lang.String v, java.lang.String label, int argId, java.lang.String css, int size)
protected void	renderTwoFactorOptions(MarkupOutput out, java.util.Map<java.lang.Integer,java.lang.String> settings)
protected void	renderUserRegistrationOptions(MarkupOutput out, java.util.Map<java.lang.Integer,java.lang.String> settings)
protected void	setBoneProperties(JsonGenerator boneProps)	Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter) Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput) Can be overwritten to add or modify bone properties.
protected void	showSubmitButtons(MarkupOutput out)
protected void	transformBody(MarkupOutput out)
void	transformForRequestSuccessful(MarkupOutput out)	Transforms the assosciated WebBean when its status is EnumRequestStatus#WebBeanRequestSuccessful.

Methods inherited from class com.microstrategy.web.admin.transforms.AbstractServerPropertiesTransform

getDescription, getInfoTooltip, getPreference, initializeCss, initializeImages, renderSaveButton, showCheckBoxOption, showCheckBoxOption, showConnectionPropertyName, showConnectionPropertyName, showEditBoxOption, showHR, showOption, showOptionHeading, showRadioButtonOption, showSubHeading

Methods inherited from class com.microstrategy.web.admin.transforms.AbstractAdminTransform

getSupportedBeanType, initializeDoubleByte, updateStyleForButtons

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, getArgumentName, 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, 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, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

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

UsherConfigTransform

public UsherConfigTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform. It also invokes the initializeImages and initializeCss methods.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractServerPropertiesTransform

Parameters:

data - The data (bean) that this transform is going to transform.

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Transforms the assosciated WebBean when its status is EnumRequestStatus#WebBeanRequestSuccessful.

Overrides:

transformForRequestSuccessful in class AbstractServerPropertiesTransform

Parameters:

out - MarkupOutput instance where the contents of this transform will be saved.

See Also:

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

transformBody

protected void transformBody(MarkupOutput out)

Specified by:

transformBody in class AbstractServerPropertiesTransform

renderServerError

protected void renderServerError(MarkupOutput out)

Overrides:

renderServerError in class AbstractServerPropertiesTransform

renderTextField

protected void renderTextField(MarkupOutput out,
                               java.lang.String v,
                               java.lang.String label,
                               int argId,
                               java.lang.String css,
                               int size)

renderImportUsherUserOption

protected void renderImportUsherUserOption(MarkupOutput out,
                                           java.util.Map<java.lang.Integer,java.lang.String> settings)

getImportUsherUserFromSettings

public java.lang.String getImportUsherUserFromSettings(java.util.Map<java.lang.Integer,java.lang.String> settings)

renderTwoFactorOptions

protected void renderTwoFactorOptions(MarkupOutput out,
                                      java.util.Map<java.lang.Integer,java.lang.String> settings)

getSecondFactorFromSettings

public java.lang.String getSecondFactorFromSettings(java.util.Map<java.lang.Integer,java.lang.String> settings)

renderUserRegistrationOptions

protected void renderUserRegistrationOptions(MarkupOutput out,
                                             java.util.Map<java.lang.Integer,java.lang.String> settings)

getUserRegistrationOptionFromSettings

public java.lang.String getUserRegistrationOptionFromSettings(java.util.Map<java.lang.Integer,java.lang.String> settings)

getUserRegistrationEmailDomainFromSettings

public java.lang.String getUserRegistrationEmailDomainFromSettings(java.util.Map<java.lang.Integer,java.lang.String> settings)

renderLoginInfo

protected void renderLoginInfo(MarkupOutput out,
                               java.util.Map<java.lang.Integer,java.lang.String> settings)

showSubmitButtons

protected void showSubmitButtons(MarkupOutput out)

Overrides:

showSubmitButtons in class AbstractServerPropertiesTransform

getTitle

protected java.lang.String getTitle()

Specified by:

getTitle in class AbstractServerPropertiesTransform

getSaveConnectEvent

protected WebEvent getSaveConnectEvent()

Specified by:

getSaveConnectEvent in class AbstractServerPropertiesTransform

setBoneProperties

protected void setBoneProperties(JsonGenerator boneProps)

Description copied from class: AbstractAppTransform

Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter)
Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Overrides:

setBoneProperties in class AbstractAppTransform

Parameters:

boneProps - the JsonGenerator object that contains the collection of bone properties.

isAutoCompleteEnabled

public boolean isAutoCompleteEnabled()