Class DiagnosticsPropertiesTransform
- 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.AbstractDiagnosticsTransform
-
- com.microstrategy.web.admin.transforms.DiagnosticsPropertiesTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class DiagnosticsPropertiesTransform extends AbstractDiagnosticsTransform
Title: DiagnosticsPropertiesTransform This class is used to display the interface required for changing diagnostic properties which are applicable to all servers: level of logging, base diagnostic configuration file, etc.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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.AbstractDiagnosticsTransform
_imgLeftCorner, _imgRightCorner, cssGlobal, cssHeaderTable, cssMainTableHeading
-
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 DiagnosticsPropertiesTransform()
Class constructor, initializes formal parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns the description of this transformprotected java.lang.String
getSetupJavascript(DiagnosticsBean bean, WebEvent applyEvent, int diagnosticType)
Obtains the javascript to be added to the diagnostic type option for enabling its options if its radio button is selected - and disabling any other options from the other types of diagnostic setup.protected java.lang.String
getTitle()
Returns the title for the interface to displayvoid
initializeCss()
Initializes the Css Classes to use.void
renderCustomPathRow(MarkupOutput out, WebEvent applyEvent, DiagnosticsBean bean)
For the Custom Diagnostic configuration, it renders the form interface required for showing the path to be used for the file from where the diagnostic configuration information shall be retrieved.void
renderCustomSetup(MarkupOutput out)
Show the interface related with the diagnostics custom options: indicate which will it be now its source file.void
renderDiagnosticOutput(MarkupOutput out)
Generates the graphical output for the DiagnosticsBean, which for this transform's definition, will consist on the different options for diagnostic logging that can be configured by the user.void
renderDiagnosticSetupOptions(MarkupOutput out)
Render the different setup options for the diagnostics.void
renderDiagnosticTypeOptionSection(DiagnosticsBean bean, WebEvent event, MarkupOutput out, int diagnosticType, java.lang.String onClick)
Deprecated.This signature of this method does not follow Microstrategy Web standards.void
renderDiagnosticTypeOptionSection(MarkupOutput out, DiagnosticsBean bean, WebEvent event, int diagnosticType, java.lang.String onClick)
Render the radio button that will allow the user to select the given diagnostic type option.void
renderFormHiddenInputs(MarkupOutput out, WebEvent applyEvent, WebEvent loadDefaults)
Add to the global output any hidden inputs that should be rendered for the proper functionality of the form that shows the user the configuration options for diagnostic logging.protected void
renderInternalAdvancedDisabledRadioButton(MarkupOutput out)
Renders the "Disabled" radio button on the Advanced Loggers Sectionprotected void
renderInternalAdvancedLevel(MarkupOutput out)
Renders the internal advanced options levels listprotected void
renderInternalAdvancedLoggerOptions(MarkupOutput out)
Renders the internal advanced logger optionsprotected void
renderInternalAdvancedOthersRadioButton(MarkupOutput out)
Renders the "Enable logging for multiple/other package(s)" radio button on the Advanced Loggers Sectionprotected void
renderInternalAdvancedPackage(MarkupOutput out)
Renders the internal advanced options package nameprotected void
renderInternalAdvancedPattern(MarkupOutput out)
Renders the internal advanced options patternprotected void
renderInternalAdvancedSessionRadioButton(MarkupOutput out)
Renders the "Enable session logger" radio button on the Advanced Loggers Sectionprotected void
renderInternalAdvancedTitle(MarkupOutput out)
Renders the internal advanced options titleprotected void
renderInternalAdvancedUser(MarkupOutput out)
Renders the internal advanced options user nameprotected void
renderInternalAdvancedXMLAPIRadioButton(MarkupOutput out)
Renders the "Enable XML-API logger" radio button on the Advanced Loggers Sectionprotected void
renderInternalAdvancedXMLAPIUser(MarkupOutput out)
Renders the internal advanced options user name for the "Enable XML-API logger" optionvoid
renderInternalFlashProfilerOptionsRow(MarkupOutput out, WebEvent applyEvent, DiagnosticsBean bean)
For the Internal Diagnostic configuration, it renders the form interface required for showing the Flash Profiler options.void
renderInternalLevelOptionsRow(MarkupOutput out, WebEvent applyEvent, DiagnosticsBean bean)
For the Internal Diagnostic configuration, it renders the form interface required for showing the different levels available in a combo box.void
renderInternalPathRow(MarkupOutput out, WebEvent applyEvent, DiagnosticsBean bean)
For the Internal Diagnostic configuration, it renders the form interface required for showing the path to be used for the file where the diagnostics are to be saved.void
renderInternalSetup(MarkupOutput out)
Show the interface related with the diagnostics internal options: change the level of logging (off, severe, warnings, etc) and update the location of the log that will be created.-
Methods inherited from class com.microstrategy.web.admin.transforms.AbstractDiagnosticsTransform
getApplyDiagnosticsEvent, getArgumentName, getDiagnosticsBean, getLoadDefaultsEvent, getSupportedBeanType, initializeImages, initializeTransform, renderDialogHeader, renderSubmitButtons, transformForRequestSuccessful
-
Methods inherited from class com.microstrategy.web.admin.transforms.AbstractAdminTransform
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, 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, setBoneProperties, 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
-
-
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Returns the description of this transform- Returns:
- String value with the description of this transform
-
initializeCss
public void initializeCss()
Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.- Overrides:
initializeCss
in classAbstractDiagnosticsTransform
-
renderDiagnosticOutput
public void renderDiagnosticOutput(MarkupOutput out)
Generates the graphical output for the DiagnosticsBean, which for this transform's definition, will consist on the different options for diagnostic logging that can be configured by the user.
The output is inside an HTML TABLE tag for formatting purposes. This method displays the header of the property box, plus the form where the user can specify the values of the different options.- Specified by:
renderDiagnosticOutput
in classAbstractDiagnosticsTransform
- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
renderFormHiddenInputs
public void renderFormHiddenInputs(MarkupOutput out, WebEvent applyEvent, WebEvent loadDefaults)
Add to the global output any hidden inputs that should be rendered for the proper functionality of the form that shows the user the configuration options for diagnostic logging.- Parameters:
out
-MarkupOutput
instance where the HTML contents are to be saved.applyEvent
-WebEvent
for applying the changes indicated on the formloadDefaults
-WebEvent
for loading the default values on the form
-
renderDiagnosticSetupOptions
public void renderDiagnosticSetupOptions(MarkupOutput out)
Render the different setup options for the diagnostics. It covers the internal and the custom types (callingrenderInternalSetup()
andrenderCustomSetup()
). This method is called fromrenderDiagnosticOutput()
which by default opens a TABLE HTML tag, therefore, either this method and/or its children's output should be formatted inside TR HTML tags.- Parameters:
out
-MarkupOutput
instance where the HTML contents are to be saved.
-
renderDiagnosticTypeOptionSection
public void renderDiagnosticTypeOptionSection(DiagnosticsBean bean, WebEvent event, MarkupOutput out, int diagnosticType, java.lang.String onClick)
Deprecated.This signature of this method does not follow Microstrategy Web standards. UserenderDiagnosticTypeOptionSection(MarkupOutput out, DiagnosticsBean bean, WebEvent event, int diagnosticType, String onClick)
Render the radio button that will allow the user to select the given diagnostic type option. Called fromrenderInternalSetup()
andrenderCustomSetup()
.- Parameters:
bean
-DiagnosticsBean
instance currently being transformedevent
-WebEvent
used for applying or saving the form details.out
-MarkupOutput
instance where HTML contents are to be saved.diagnosticType
-int
representing the diagnostic type to be displayed (the current value that indicates if the radio button is to be selected or not comes from theDiagnosticsBean
property). Possible values includeDiagnosticsBean.DIAGNOSTICS_TYPE_DEFAULT
,DiagnosticsBean.DIAGNOSTICS_TYPE_CUSTOM
.onClick
- String with javascript information to associate to the onclick event
-
renderDiagnosticTypeOptionSection
public void renderDiagnosticTypeOptionSection(MarkupOutput out, DiagnosticsBean bean, WebEvent event, int diagnosticType, java.lang.String onClick)
Render the radio button that will allow the user to select the given diagnostic type option. Called fromrenderInternalSetup()
andrenderCustomSetup()
.- Parameters:
bean
-DiagnosticsBean
instance currently being transformedevent
-WebEvent
used for applying or saving the form details.out
-MarkupOutput
instance where HTML contents are to be saved.diagnosticType
-int
representing the diagnostic type to be displayed (the current value that indicates if the radio button is to be selected or not comes from theDiagnosticsBean
property). Possible values includeDiagnosticsBean.DIAGNOSTICS_TYPE_DEFAULT
,DiagnosticsBean.DIAGNOSTICS_TYPE_CUSTOM
.onClick
- String with javascript information to associate to the onclick event- Since:
- MicroStrategy Web 8.0.1
-
renderInternalSetup
public void renderInternalSetup(MarkupOutput out)
Show the interface related with the diagnostics internal options: change the level of logging (off, severe, warnings, etc) and update the location of the log that will be created.
Its contents are inside a table TR, with two (merged) columns, therefore, the parent TABLE tag should be already opened. By default, the mainrenderDiagnosticOutput()
takes care of it.- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed
-
renderInternalAdvancedLoggerOptions
protected void renderInternalAdvancedLoggerOptions(MarkupOutput out)
Renders the internal advanced logger options- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalAdvancedTitle
protected void renderInternalAdvancedTitle(MarkupOutput out)
Renders the internal advanced options title- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalAdvancedDisabledRadioButton
protected void renderInternalAdvancedDisabledRadioButton(MarkupOutput out)
Renders the "Disabled" radio button on the Advanced Loggers Section- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalAdvancedXMLAPIRadioButton
protected void renderInternalAdvancedXMLAPIRadioButton(MarkupOutput out)
Renders the "Enable XML-API logger" radio button on the Advanced Loggers Section- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalAdvancedXMLAPIUser
protected void renderInternalAdvancedXMLAPIUser(MarkupOutput out)
Renders the internal advanced options user name for the "Enable XML-API logger" option- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalAdvancedSessionRadioButton
protected void renderInternalAdvancedSessionRadioButton(MarkupOutput out)
Renders the "Enable session logger" radio button on the Advanced Loggers Section- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 10.8.0
-
renderInternalAdvancedOthersRadioButton
protected void renderInternalAdvancedOthersRadioButton(MarkupOutput out)
Renders the "Enable logging for multiple/other package(s)" radio button on the Advanced Loggers Section- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalAdvancedPackage
protected void renderInternalAdvancedPackage(MarkupOutput out)
Renders the internal advanced options package name- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalAdvancedUser
protected void renderInternalAdvancedUser(MarkupOutput out)
Renders the internal advanced options user name- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalAdvancedPattern
protected void renderInternalAdvancedPattern(MarkupOutput out)
Renders the internal advanced options pattern- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalAdvancedLevel
protected void renderInternalAdvancedLevel(MarkupOutput out)
Renders the internal advanced options levels list- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed- Since:
- MicroStrategy Web 8.0.2
-
renderInternalLevelOptionsRow
public void renderInternalLevelOptionsRow(MarkupOutput out, WebEvent applyEvent, DiagnosticsBean bean)
For the Internal Diagnostic configuration, it renders the form interface required for showing the different levels available in a combo box. Uses therenderInternalLevelOptions()
method. Originally called by therenderInternalSetup()
method. Displays the HTML contents inside a table TR with two cells.- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayedapplyEvent
-WebEvent
to be called for applying these changes. If the event is customized, this method will need to be updated as well.bean
-DiagnosticsBean
instance being transformed.
-
renderInternalFlashProfilerOptionsRow
public void renderInternalFlashProfilerOptionsRow(MarkupOutput out, WebEvent applyEvent, DiagnosticsBean bean)
For the Internal Diagnostic configuration, it renders the form interface required for showing the Flash Profiler options.- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayedapplyEvent
-WebEvent
to be called for applying these changes. If the event is customized, this method will need to be updated as well.bean
-DiagnosticsBean
instance being transformed.
-
renderInternalPathRow
public void renderInternalPathRow(MarkupOutput out, WebEvent applyEvent, DiagnosticsBean bean)
For the Internal Diagnostic configuration, it renders the form interface required for showing the path to be used for the file where the diagnostics are to be saved. Originally called by therenderInternalSetup()
method. Displays the HTML contents inside a table TR with two cells.- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayedapplyEvent
-WebEvent
to be called for applying these changes. If the event is customized, this method will need to be updated as well.bean
-DiagnosticsBean
instance being transformed.
-
renderCustomSetup
public void renderCustomSetup(MarkupOutput out)
Show the interface related with the diagnostics custom options: indicate which will it be now its source file.
Its contents are inside a table TR, with two (merged) columns, therefore, the parent TABLE tag should be already opened. By default, the mainrenderDiagnosticOutput()
takes care of it.- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayed
-
renderCustomPathRow
public void renderCustomPathRow(MarkupOutput out, WebEvent applyEvent, DiagnosticsBean bean)
For the Custom Diagnostic configuration, it renders the form interface required for showing the path to be used for the file from where the diagnostic configuration information shall be retrieved. Originally called by therenderCustomSetup()
method. Displays the HTML contents inside a table row with two cells.- Parameters:
out
-MarkupOutput
instance to contain the HTML to be displayedapplyEvent
-WebEvent
to be called for applying these changes.bean
-DiagnosticsBean
instance being transformed.
-
getSetupJavascript
protected java.lang.String getSetupJavascript(DiagnosticsBean bean, WebEvent applyEvent, int diagnosticType)
Obtains the javascript to be added to the diagnostic type option for enabling its options if its radio button is selected - and disabling any other options from the other types of diagnostic setup. If the applyEvent is customized with thegetApplyDiagnosticsEvent()
method, this method should also be customized since it works based on the arguments of this event.- Parameters:
bean
-DiagnosticsBean
currently being transformedapplyEvent
-WebEvent
used for applying changes on the formdiagnosticType
-int
representing the diagnostic type to be displayed the javascript for. Possible values includeDiagnosticsBean.DIAGNOSTICS_TYPE_DEFAULT
,DiagnosticsBean.DIAGNOSTICS_TYPE_CUSTOM
.- Returns:
- a
String
with the javascript to include for the diagnostic type section. If the diagnostic type indicated is not implemented on this method, returns an emtpyStrign
.
-
getTitle
protected java.lang.String getTitle()
Returns the title for the interface to display- Specified by:
getTitle
in classAbstractDiagnosticsTransform
- Returns:
- the text to display as title of the transform
-
-