Interface PerformanceMonitorBean

    • Method Detail

      • addCounter

        void addCounter​(java.lang.String serverName,
                        java.lang.String category,
                        java.lang.String instance,
                        java.lang.String counter)
                 throws WebBeanException,
                        java.lang.IllegalArgumentException
        This method tells the API to begin monitoring the given counter. This must be called for each counter for which data will be retrieved. The method adds the counter to the existing WebMonitor object on the bean.
        Parameters:
        serverName - The name of the Intelligence Server that the counter resides upon.
        category - The name of the category.
        instance - The name of the instance.
        counter - The name of the counter.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given counter does not exist on the given
        WebBeanException - Thrown if error countered while loading the WebMonitor object. Intelligence Server.
      • addCounter

        void addCounter​(java.lang.String category,
                        java.lang.String instance,
                        java.lang.String counter)
                 throws WebBeanException,
                        java.lang.IllegalArgumentException
        This method tells the API to begin monitoring the given counter. The counter will be monitored on the counter which the session is associated with on the bean. This must be called for each counter for which data will be retrieved. The method adds the counter to the existing WebMonitor object on the bean.
        Parameters:
        category - The name of the category.
        instance - The name of the instance.
        counter - The name of the counter.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given counter does not exist on the given
        WebBeanException - Thrown if error countered while loading the WebMonitor object. Intelligence Server.
        Since:
        MicroStrategy Web 7.5.2
      • removeCounter

        void removeCounter​(java.lang.String serverName,
                           java.lang.String category,
                           java.lang.String instance,
                           java.lang.String counter)
                    throws WebBeanException,
                           java.lang.IllegalArgumentException
        This method tells the API to quit monitoring the given counter, if it is being monitored. The method removes the counter from the existing WebMonitor object on the bean.
        Parameters:
        serverName - The name of the Intelligence Server that the counter resides upon.
        category - The name of the category.
        instance - The name of the instance.
        counter - The name of the counter.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given counter does not exist or is not being logged on the given
        WebBeanException - Thrown if error countered while loading the WebMonitor object. Intelligence Server.
      • removeCounter

        void removeCounter​(java.lang.String category,
                           java.lang.String instance,
                           java.lang.String counter)
                    throws WebBeanException,
                           java.lang.IllegalArgumentException
        This method tells the API to quit monitoring the given counter, if it is being monitored. The method removes the counter from the existing WebMonitor object on the bean. This method will quit monitoring a monitor type which has no server associated with it, which means to only monitor the server that the session is created on.
        Parameters:
        category - The name of the category.
        instance - The name of the instance.
        counter - The name of the counter.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given counter does not exist or is not being logged on the given
        WebBeanException - Thrown if error countered while loading the WebMonitor object. Intelligence Server.
        Since:
        MicroStrategy Web 7.5.2
      • getMonitoredCategories

        Categories getMonitoredCategories​(java.lang.String serverName)
                                   throws WebBeanException
        Returns a Categories collection of the monitored categories for the given server. This collection will only contain those counters which are currently being monitored by this bean.
        Parameters:
        serverName - The name of the Intelligence Server to obtain counters for.
        Returns:
        A Categories collection containing only those counters being monitored.
        Throws:
        WebBeanException - thrown if there is a problem retrieving information from the specified server
      • getAvailableCategories

        Categories getAvailableCategories​(java.lang.String serverName)
        Returns a Categories collection of the categories which are available on the given server.
        Parameters:
        serverName - The name of the Intelligence Server to obtain counters for.
        Returns:
        A Categories collection containing all available counters for the server.
      • isMonitored

        boolean isMonitored​(java.lang.String serverName,
                            java.lang.String category,
                            java.lang.String instance,
                            java.lang.String counter)
                     throws WebBeanException
        Returns whether the given counter is monitored.
        Parameters:
        serverName - The name of the server that the monitor belongs to.
        category - The name of the category.
        instance - The name of the instance.
        counter - The name of the counter.
        Returns:
        Whether the given monitor is currently enabled.
        Throws:
        WebBeanException - thrown if there is a problem retrieving information from the specified server
      • setMonitorID

        void setMonitorID​(java.lang.String monitorID)
                   throws java.lang.IllegalArgumentException
        Sets the monitor ID corresponding to the WebPerformanceMonitor to use to monitor using this bean.
        Parameters:
        monitorID - The ID of the performance monitor.
        Throws:
        java.lang.IllegalArgumentException - if the monitor ID passed is incorrect.
      • setMonitor

        void setMonitor​(WebPerformanceMonitor monitor)
        Sets the WebPerformanceMonitor to use to monitor using this bean.
        Parameters:
        monitor - The performance monitor that the bean should use to monitor.
      • getMonitorID

        java.lang.String getMonitorID()
        Returns the DSSID of the WebPerformanceMonitor that this bean is monitoring.
        Returns:
        DSSID of the performance monitor being monitored by the bean.