Interface JMSStatusMBean

  • All Known Implementing Classes:
    JMSStatus

    public interface JMSStatusMBean
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void dumpServerState​(String path)
      Generates a server dump.
      int getDelay()
      Returns the minimal delay between 2 dumps.
      int getPeriod()
      Returns the activation period in seconds.
      int getStatus()
      Returns the global healthcheck indication, 0 if all connectors are running, 1 otherwise.
      String getStatusInfo()
      Returns a user friendly indication of the global healthcheck: RUNNING or UNREACHABLE.
      int getThreshold()
      Returns the minimum number of failures before generating a dump.
      int getTimeout()
      Returns the timeout used during check.
      void setDelay​(int delay)
      Sets the minimal delay between 2 dumps.
      void setPeriod​(int period)
      Sets the activation period in seconds.
      void setThreshold​(int threshold)
      Sets the minimum number of failures before generating a dump.
      void setTimeout​(int timeout)
      Sets the timeout used during check.
      void start()
      Starts the JMS healthcheck component.
      void stop()
      Stops the JMS healthcheck component.
    • Method Detail

      • start

        void start()
            throws Exception
        Starts the JMS healthcheck component.
        Throws:
        Exception
      • stop

        void stop()
           throws Exception
        Stops the JMS healthcheck component.
        Throws:
        Exception
      • getStatus

        int getStatus()
        Returns the global healthcheck indication, 0 if all connectors are running, 1 otherwise.
        Returns:
        the global healthcheck indication.
      • getStatusInfo

        String getStatusInfo()
        Returns a user friendly indication of the global healthcheck: RUNNING or UNREACHABLE.
        Returns:
        a user friendly indication of the global healthcheck
      • getPeriod

        int getPeriod()
        Returns the activation period in seconds.
        Returns:
        the activation period in seconds.
      • setPeriod

        void setPeriod​(int period)
        Sets the activation period in seconds.
        Parameters:
        period - the activation period in seconds.
      • getTimeout

        int getTimeout()
        Returns the timeout used during check.
        Returns:
        the timeout used during check.
      • setTimeout

        void setTimeout​(int timeout)
        Sets the timeout used during check.
        Parameters:
        timeout - the timeout used during check.
      • getThreshold

        int getThreshold()
        Returns the minimum number of failures before generating a dump.
        Returns:
        the minimum number of failures before generating a dump.
      • setThreshold

        void setThreshold​(int threshold)
        Sets the minimum number of failures before generating a dump.
        Parameters:
        threshold - the minimum number of failures before generating a dump.
      • getDelay

        int getDelay()
        Returns the minimal delay between 2 dumps.
        Returns:
        the minimal delay between 2 dumps.
      • setDelay

        void setDelay​(int delay)
        Sets the minimal delay between 2 dumps.
        Parameters:
        delay - the minimal delay between 2 dumps.
      • dumpServerState

        void dumpServerState​(String path)
        Generates a server dump.
        Parameters:
        path - Pathname of file to create.