Class DiagnosticsViewerTransform
- 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.DiagnosticsViewerTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class DiagnosticsViewerTransform extends AbstractDiagnosticsTransform
Title DiagnosticsViewerTransform This class is used to view diagnostic log contents which are applicable to all servers- 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 DiagnosticsViewerTransform()
Class constructor, initializes formal parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected AnchorTag
generateAnchor(WebEvent event)
Overwrites the parent method by setting the typical url information on the link (thus disabling any default onclick definition)protected WebEvent
getApplyDiagnosticsEvent(DiagnosticsBean bean)
Generate the event that will be used for applying or saving the diagnostics configuration specified on the form.java.lang.String
getDescription()
Returns the description of this transformprotected WebEvent
getSortEvent(DiagnosticsBean bean)
Get the event to use for sorting the contents of the diagnostics file.protected java.lang.String
getSortImage(int sort)
Deprecated.This method is no longer used.protected java.lang.String
getSortImageCss(int sort)
Get the image css to render based on the current sort mode.protected java.lang.String
getTitle()
Returns the title for the interface to displayvoid
initializeCss()
Initializes the Css Classes to use.void
renderDateComboBoxes(MarkupOutput out, LocaleInfo locale, java.lang.String label, java.lang.String paramDay, java.lang.String paramMonth, java.lang.String paramYear, int day, int month, int year, boolean hasError)
Display the requested date combo box inside two TD cells (therefore, the parent TR and TABLE should be already opened).void
renderDateViewingOptionsRow(MarkupOutput out, WebEvent applyEvent)
Append to the MarkupOutput the rows and cells with the TO and FROM information for filtering the log contents.void
renderDiagnosticOutput(MarkupOutput out)
Generates the graphical output for the DiagnosticsBean, which for this transform's definition, will consist on an option box for the user to select which information s/he wants to read, plus a list of the logs recorded that are within the search parameters specified.void
renderDisplayViewingOptionsRow(MarkupOutput out, WebEvent applyEvent)
Show the options for viewing the log: which type of messages to see and from which date to which.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 formvoid
renderIncrementalFetch(MarkupOutput out, int pageNumber, int low, int up, int total, int pageSize)
Add the incremental fetch information given the information passed as parametersboolean
renderLogFile(MarkupOutput out, DOMSupport domSupport, org.w3c.dom.Document errorsXML)
Show the log file contents, according to the specified filters and sortingvoid
renderViewerError(MarkupOutput out, java.lang.String message)
Display any error message found while processing the log filesvoid
renderViewerOptions(MarkupOutput out, WebEvent applyEvent, WebEvent loadDefaultsEvent, DiagnosticsBean bean)
Render the interface that shows the user the different options for viewing the log contents: type of logs and dates to cover.protected void
setSortOrderEvent(WebEvent event, int sortOrder)
Sets the event to execute the indicated sort if requested.-
Methods inherited from class com.microstrategy.web.admin.transforms.AbstractDiagnosticsTransform
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, 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 an option box for the user to select which information s/he wants to read, plus a list of the logs recorded that are within the search parameters specified.- Specified by:
renderDiagnosticOutput
in classAbstractDiagnosticsTransform
- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
renderViewerOptions
public void renderViewerOptions(MarkupOutput out, WebEvent applyEvent, WebEvent loadDefaultsEvent, DiagnosticsBean bean)
Render the interface that shows the user the different options for viewing the log contents: type of logs and dates to cover.- Parameters:
out
-MarkupOutput
instance where the HTML to render is to be savedapplyEvent
-WebEvent
used for submitting the form changesloadDefaultsEvent
-WebEvent
used for loading the default values on the formbean
-DiagnosticsBean
instance being transformed
-
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- 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
-
renderDisplayViewingOptionsRow
public void renderDisplayViewingOptionsRow(MarkupOutput out, WebEvent applyEvent)
Show the options for viewing the log: which type of messages to see and from which date to which.
The contents generated by this method are inside several TR tags with two columns, therefore the parent TABLE should be already opened. By default the callerrenderViewerOptions()
takes care of it.- Parameters:
out
-MarkupOutput
instance that contains the HTML to displayapplyEvent
-WebEvent
instance with the information for applying the options displayed here
-
renderDateViewingOptionsRow
public void renderDateViewingOptionsRow(MarkupOutput out, WebEvent applyEvent)
Append to the MarkupOutput the rows and cells with the TO and FROM information for filtering the log contents.
The contents generated by this method are inside several TR tags with two columns, therefore the parent TABLE should be already opened. By default the callerrenderViewerOptions()
takes care of it.- Parameters:
out
- theMarkupOutput
to modifyapplyEvent
-WebEvent
instance with the information for applying the options displayed here
-
renderLogFile
public boolean renderLogFile(MarkupOutput out, DOMSupport domSupport, org.w3c.dom.Document errorsXML)
Show the log file contents, according to the specified filters and sorting- Parameters:
out
- the MarkupOutput instance to modify with the HTML to be displayederrorsXML
-Document
instance with the logging information to render to the userdomSupport
-DOMSupport
instance for processing theDocument
instance to render- Returns:
True
if the execution of the method ended in error (therefore the out parameter contains the error message, not the log display).False
if no errors happened.
-
renderViewerError
public void renderViewerError(MarkupOutput out, java.lang.String message)
Display any error message found while processing the log files- Parameters:
out
-MarkupOutput
instancemessage
- string with message to show to the user
-
renderDateComboBoxes
public void renderDateComboBoxes(MarkupOutput out, LocaleInfo locale, java.lang.String label, java.lang.String paramDay, java.lang.String paramMonth, java.lang.String paramYear, int day, int month, int year, boolean hasError)
Display the requested date combo box inside two TD cells (therefore, the parent TR and TABLE should be already opened).- Parameters:
out
- MarkupOutput instance to modifylocale
- LocaleInfo instance, for getting the mm-dd-yy format (default)label
- The label to display next to the combo boxesparamDay
- name of the day parameterparamMonth
- name of the month parameterparamYear
- name of the year parameterday
- current daymonth
- current monthyear
- current yearhasError
- boolean value indicating if the information to render has an error
-
renderIncrementalFetch
public void renderIncrementalFetch(MarkupOutput out, int pageNumber, int low, int up, int total, int pageSize)
Add the incremental fetch information given the information passed as parameters- Parameters:
out
- MarkupOutput instance to updatepageNumber
- number of page currently displayedlow
- Lower limit on the displayup
- Upper limit on the displaytotal
- Total number of records to displaypageSize
- Size of the page to display
-
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
-
getApplyDiagnosticsEvent
protected WebEvent getApplyDiagnosticsEvent(DiagnosticsBean bean)
Generate the event that will be used for applying or saving the diagnostics configuration specified on the form. Overwrites the original method for generating one that will make the log files from the selected date to be loaded.- Overrides:
getApplyDiagnosticsEvent
in classAbstractDiagnosticsTransform
- Parameters:
bean
-DiagnosticsBean
being transformed- Returns:
- a
WebEvent
with the corresponding event,null
if the application does not support it.
-
getSortImage
protected java.lang.String getSortImage(int sort)
Deprecated.This method is no longer used. Use CSS classes via getSortImageCss(int sort)Get the image to render based on the current sort mode.- Parameters:
sort
-int
value indicating the type of sorting. For example:DiagnosticsBean.SORT_BY_LEVEL_DESCENDING
,DiagnosticsBean.SORT_BY_TIMESTAMP_DESCENDING
, etc.- Returns:
- the corresponding sorting image to render
-
getSortImageCss
protected java.lang.String getSortImageCss(int sort)
Get the image css to render based on the current sort mode.- Parameters:
sort
-int
value indicating the type of sorting. For example:DiagnosticsBean.SORT_BY_LEVEL_DESCENDING
,DiagnosticsBean.SORT_BY_TIMESTAMP_DESCENDING
, etc.- Returns:
- the corresponding sorting image to render
-
getSortEvent
protected WebEvent getSortEvent(DiagnosticsBean bean)
Get the event to use for sorting the contents of the diagnostics file.- Parameters:
bean
-DiagnosticsBean
currently being transformed.- Returns:
WebEvent
initialized with the event, but without specifying which sorting will be executed if requested.
-
setSortOrderEvent
protected void setSortOrderEvent(WebEvent event, int sortOrder)
Sets the event to execute the indicated sort if requested.- Parameters:
event
- a not-nullWebEvent
instance, where to set the sort order requestedsortOrder
-int
indicating the sort order to request if the event is called. Valid values includeDiagnosticsBean.SORT_BY_TIMESTAMP_DESCENDING
, etc.
-
generateAnchor
protected AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting the typical url information on the link (thus disabling any default onclick definition)- Overrides:
generateAnchor
in classAbstractAppTransform
- Parameters:
event
- WebEvent base information for the link- Returns:
AnchorTag
instance initialized- Since:
- MicroStrategy Web 8.0.0
-
-