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

Interface TraditionalWorkQueueCfg

  • All Superinterfaces:
    Configuration, WorkQueueCfg
    public interface TraditionalWorkQueueCfg
extends WorkQueueCfg
    A server-side interface for querying 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

      • addTraditionalChangeListener

        void addTraditionalChangeListener​(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener)
        Register to be notified when this Traditional Work Queue is changed.
        Parameters:
        listener - The Traditional Work Queue configuration change listener.

      • removeTraditionalChangeListener

        void removeTraditionalChangeListener​(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener)
        Deregister an existing Traditional Work Queue configuration change listener.
        Parameters:
        listener - The Traditional Work Queue configuration change listener.

      • 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 WorkQueueCfg
        Returns:
        Returns the value of the "java-class" property.

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

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