Package com.opencloud.rhino.config.staging

Interface StagingQueueManagementMBean

  • public interface StagingQueueManagementMBean

    The StagingQueueManagementMBean interface provides methods to configure the staging queue parameters.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String MBEAN_NAME
      The name of this MBean, equal to the string "StagingQueue".
      static String OBJECT_NAME
      The JMX Object Name of this MBean.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      long getMaximumAge()
      Get the maximum age that an item is allowed to be when it is removed and processed from the staging queue.
      int getMaximumSize()
      Get the maximum size of the staging queue.
      int getThreadCount()
      Get the number of threads processing items in the queue.
      void setMaximumAge​(long ms)
      Set the maximum age of items removed from the staging queue for processing in ms.
      void setMaximumSize​(int size)
      Set the maximum size of the staging queue.
      void setThreadCount​(int threads)
      The number of threads processing items on the queue.

    • Method Detail

      • setMaximumSize

        void setMaximumSize​(int size)
             throws ConfigurationException,
                    com.opencloud.util.exception.ValidationException

        Set the maximum size of the staging queue. The number of items in the queue can never exceed this amount. If the queue is full when an item is added the oldest item on the queue is discarded and the new item added.

        Parameters:
        size - the maximum size of the staging queue
        Throws:
        ConfigurationException
        com.opencloud.util.exception.ValidationException

      • setMaximumAge

        void setMaximumAge​(long ms)
            throws ConfigurationException,
                   com.opencloud.util.exception.ValidationException

        Set the maximum age of items removed from the staging queue for processing in ms. If an item scheduled for removal has been in the queue for longer than this amount of time it is discarded and not processed. If this is set to -1 then items do not get "too old".

        Parameters:
        ms - the maximum amount of time (ms) an item can be in the staging queue before it is discarded, -1 for infinite amount of time
        Throws:
        ConfigurationException
        com.opencloud.util.exception.ValidationException

      • setThreadCount

        void setThreadCount​(int threads)
             throws ConfigurationException,
                    com.opencloud.util.exception.ValidationException

        The number of threads processing items on the queue.

        Parameters:
        threads - the number of threads
        Throws:
        ConfigurationException
        com.opencloud.util.exception.ValidationException

      • getMaximumAge

        long getMaximumAge()
            throws ConfigurationException

        Get the maximum age that an item is allowed to be when it is removed and processed from the staging queue. Items older than this will be discarded instead of processed.

        Returns:
        the maximum age an item may be if it is to be processed, -1 if any age item can be processed
        Throws:
        ConfigurationException