Package org.forgerock.opendj.server.config.client

Interface TraditionalWorkQueueCfgClient

  • All Superinterfaces:
    ConfigurationClient, WorkQueueCfgClient
    public interface TraditionalWorkQueueCfgClient
extends WorkQueueCfgClient
    A client-side interface for reading and modifying Traditional Work Queue settings.

    The Traditional Work Queue is a type of work queue that uses a number of worker threads that watch a queue and pick up an operation to process whenever one becomes available.

    • Method Detail

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the Traditional Work Queue implementation.

        Specified by:
        getJavaClass in interface WorkQueueCfgClient
        Returns:
        Returns the value of the "java-class" property.

      • setJavaClass

        void setJavaClass​(String value)
           throws PropertyException
        Sets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the Traditional Work Queue implementation.

        Specified by:
        setJavaClass in interface WorkQueueCfgClient
        Parameters:
        value - The value of the "java-class" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getMaxWorkQueueCapacity

        int getMaxWorkQueueCapacity()
        Gets the "max-work-queue-capacity" property.

        Specifies the maximum number of queued operations that can be in the work queue at any given time.

        If the work queue is already full and additional requests are received by the server, then the server front end, and possibly the client, will be blocked until the work queue has available capacity.

        Returns:
        Returns the value of the "max-work-queue-capacity" property.

      • setMaxWorkQueueCapacity

        void setMaxWorkQueueCapacity​(Integer value)
                      throws PropertyException
        Sets the "max-work-queue-capacity" property.

        Specifies the maximum number of queued operations that can be in the work queue at any given time.

        If the work queue is already full and additional requests are received by the server, then the server front end, and possibly the client, will be blocked until the work queue has available capacity.

        Parameters:
        value - The value of the "max-work-queue-capacity" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getNumWorkerThreads

        Integer getNumWorkerThreads()
        Gets the "num-worker-threads" property.

        Specifies the number of worker threads to be used for processing operations placed in the queue.

        If the value is increased, the additional worker threads are created immediately. If the value is reduced, the appropriate number of threads are destroyed as operations complete processing.

        Returns:
        Returns the value of the "num-worker-threads" property.

      • setNumWorkerThreads

        void setNumWorkerThreads​(Integer value)
                  throws PropertyException
        Sets the "num-worker-threads" property.

        Specifies the number of worker threads to be used for processing operations placed in the queue.

        If the value is increased, the additional worker threads are created immediately. If the value is reduced, the appropriate number of threads are destroyed as operations complete processing.

        Parameters:
        value - The value of the "num-worker-threads" property.
        Throws:
        PropertyException - If the new value is invalid.