Package com.microstrategy.web.admin.transforms

Class 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

    • Constructor Detail

      • DiagnosticsPropertiesTransform

        public DiagnosticsPropertiesTransform()
        Class constructor, initializes formal parameters.
        Since:
        MicroStrategy Web 8.0.0

    • 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 class AbstractDiagnosticsTransform

      • 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 class AbstractDiagnosticsTransform
        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 form
        loadDefaults - 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 (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.

      • 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 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 DiagnosticsBean.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 main renderDiagnosticOutput() 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 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.

      • 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 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.

      • 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 main renderDiagnosticOutput() 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 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.

      • 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 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 DiagnosticsBean.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 emtpy Strign.

      • getTitle

        protected java.lang.String getTitle()
        Returns the title for the interface to display
        Specified by:
        getTitle in class AbstractDiagnosticsTransform
        Returns:
        the text to display as title of the transform