public class

DiagnosticsPropertiesTransform

extends AbstractDiagnosticsTransform
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

Class Overview

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.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.admin.transforms.AbstractDiagnosticsTransform
From class com.microstrategy.web.admin.transforms.AbstractAdminTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
DiagnosticsPropertiesTransform()
Class constructor, initializes formal parameters.
Public Methods
String getDescription()
Returns the description of this transform
void 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, String onClick)
This method is deprecated. This signature of this method does not follow Microstrategy Web standards. Use renderDiagnosticTypeOptionSection(MarkupOutput, DiagnosticsBean, WebEvent, int, String)
void renderDiagnosticTypeOptionSection(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.
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.
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.
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.
Protected Methods
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.
String getTitle()
Returns the title for the interface to display
void renderInternalAdvancedDisabledRadioButton(MarkupOutput out)
Renders the "Disabled" radio button on the Advanced Loggers Section
void renderInternalAdvancedLevel(MarkupOutput out)
Renders the internal advanced options levels list
void renderInternalAdvancedLoggerOptions(MarkupOutput out)
Renders the internal advanced logger options
void renderInternalAdvancedOthersRadioButton(MarkupOutput out)
Renders the "Enable logging for multiple/other package(s)" radio button on the Advanced Loggers Section
void renderInternalAdvancedPackage(MarkupOutput out)
Renders the internal advanced options package name
void renderInternalAdvancedPattern(MarkupOutput out)
Renders the internal advanced options pattern
void renderInternalAdvancedTitle(MarkupOutput out)
Renders the internal advanced options title
void renderInternalAdvancedUser(MarkupOutput out)
Renders the internal advanced options user name
void renderInternalAdvancedXMLAPIRadioButton(MarkupOutput out)
Renders the "Enable XML-API logger" radio button on the Advanced Loggers Section
void renderInternalAdvancedXMLAPIUser(MarkupOutput out)
Renders the internal advanced options user name for the "Enable XML-API logger" option
[Expand]
Inherited Methods
From class com.microstrategy.web.admin.transforms.AbstractDiagnosticsTransform
From class com.microstrategy.web.admin.transforms.AbstractAdminTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public DiagnosticsPropertiesTransform ()

Class constructor, initializes formal parameters.

Public Methods

public String getDescription ()

Returns the description of this transform

Returns
  • String value with the description of this transform

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.

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 the renderCustomSetup() method. Displays the HTML contents inside a table row with two cells.

Parameters
out MarkupOutput instance to contain the HTML to be displayed
applyEvent WebEvent to be called for applying these changes.
bean DiagnosticsBean instance being transformed.

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 main renderDiagnosticOutput() takes care of it.

Parameters
out MarkupOutput instance to contain the HTML to be displayed

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.

Parameters
out MarkupOutput instance where to create the HTML output

public void renderDiagnosticSetupOptions (MarkupOutput out)

Render the different setup options for the diagnostics. It covers the internal and the custom types (calling renderInternalSetup() and renderCustomSetup()). This method is called from renderDiagnosticOutput() 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.

public void renderDiagnosticTypeOptionSection (DiagnosticsBean bean, WebEvent event, MarkupOutput out, int diagnosticType, String onClick)

This method is deprecated.
This signature of this method does not follow Microstrategy Web standards. Use renderDiagnosticTypeOptionSection(MarkupOutput, DiagnosticsBean, WebEvent, int, String)

Render the radio button that will allow the user to select the given diagnostic type option. Called from renderInternalSetup() and renderCustomSetup().

Parameters
bean DiagnosticsBean instance currently being transformed
event 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 the DiagnosticsBean property). Possible values include DIAGNOSTICS_TYPE_DEFAULT, DIAGNOSTICS_TYPE_CUSTOM.
onClick String with javascript information to associate to the onclick event

public void renderDiagnosticTypeOptionSection (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 from renderInternalSetup() and renderCustomSetup().

Parameters
out MarkupOutput instance where HTML contents are to be saved.
bean DiagnosticsBean instance currently being transformed
event WebEvent used for applying or saving the form details.
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 the DiagnosticsBean property). Possible values include DIAGNOSTICS_TYPE_DEFAULT, DIAGNOSTICS_TYPE_CUSTOM.
onClick String with javascript information to associate to the onclick event

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 form
loadDefaults WebEvent for loading the default values on the form

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 displayed
applyEvent 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.

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 the renderInternalLevelOptions() method. Originally called by the renderInternalSetup() method. Displays the HTML contents inside a table TR with two cells.

Parameters
out MarkupOutput instance to contain the HTML to be displayed
applyEvent 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.

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 the renderInternalSetup() method. Displays the HTML contents inside a table TR with two cells.

Parameters
out MarkupOutput instance to contain the HTML to be displayed
applyEvent 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.

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 main renderDiagnosticOutput() takes care of it.

Parameters
out MarkupOutput instance to contain the HTML to be displayed

Protected Methods

protected 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 the getApplyDiagnosticsEvent() method, this method should also be customized since it works based on the arguments of this event.

Parameters
bean DiagnosticsBean currently being transformed
applyEvent WebEvent used for applying changes on the form
diagnosticType int representing the diagnostic type to be displayed the javascript for. Possible values include DIAGNOSTICS_TYPE_DEFAULT, 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 emtpy Strign.

protected String getTitle ()

Returns the title for the interface to display

Returns
  • the text to display as title of the transform

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

protected void renderInternalAdvancedLevel (MarkupOutput out)

Renders the internal advanced options levels list

Parameters
out MarkupOutput instance to contain the HTML to be displayed

protected void renderInternalAdvancedLoggerOptions (MarkupOutput out)

Renders the internal advanced logger options

Parameters
out MarkupOutput instance to contain the HTML to be displayed

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

protected void renderInternalAdvancedPackage (MarkupOutput out)

Renders the internal advanced options package name

Parameters
out MarkupOutput instance to contain the HTML to be displayed

protected void renderInternalAdvancedPattern (MarkupOutput out)

Renders the internal advanced options pattern

Parameters
out MarkupOutput instance to contain the HTML to be displayed

protected void renderInternalAdvancedTitle (MarkupOutput out)

Renders the internal advanced options title

Parameters
out MarkupOutput instance to contain the HTML to be displayed

protected void renderInternalAdvancedUser (MarkupOutput out)

Renders the internal advanced options user name

Parameters
out MarkupOutput instance to contain the HTML to be displayed

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

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