Package org.opends.server.extensions

Class ParallelWorkQueue

    • Constructor Detail

      • ParallelWorkQueue

        public ParallelWorkQueue()
        Creates a new instance of this work queue. All initialization should be performed in the initializeWorkQueue method.

    • Method Detail

      • finalizeWorkQueue

        public void finalizeWorkQueue​(org.forgerock.i18n.LocalizableMessage reason)
        Description copied from class: WorkQueue
        Performs any necessary finalization for this work queue, including ensuring that all active operations are interrupted or will be allowed to complete, and that all pending operations will be cancelled.
        Specified by:
        finalizeWorkQueue in class WorkQueue<ParallelWorkQueueCfg>
        Parameters:
        reason - The human-readable reason that the work queue is being shut down.

      • shutdownRequested

        public boolean shutdownRequested()
        Indicates whether this work queue has received a request to shut down.
        Returns:
        true if the work queue has recieved a request to shut down, or false if not.

      • submitOperation

        public void submitOperation​(Operation operation)
                     throws DirectoryException
        Submits an operation to be processed by one of the worker threads associated with this work queue.
        Specified by:
        submitOperation in class WorkQueue<ParallelWorkQueueCfg>
        Parameters:
        operation - The operation to be processed.
        Throws:
        DirectoryException - If the provided operation is not accepted for some reason (e.g., if the server is shutting down or the pending operation queue is already at its maximum capacity).

      • trySubmitOperation

        public boolean trySubmitOperation​(Operation operation)
                           throws DirectoryException
        Description copied from class: WorkQueue
        Tries to submit an operation to be processed in the server, without blocking.
        Specified by:
        trySubmitOperation in class WorkQueue<ParallelWorkQueueCfg>
        Parameters:
        operation - The operation to be processed.
        Returns:
        true if the operation could be submitted to the queue, false if the queue was full
        Throws:
        DirectoryException - If the provided operation is not accepted for some reason (e.g., if the server is shutting down).

      • nextOperation

        public Operation nextOperation​(ParallelWorkerThread workerThread)
        Retrieves the next operation that should be processed by one of the worker threads, blocking if necessary until a new request arrives. This method should only be called by a worker thread associated with this work queue.
        Parameters:
        workerThread - The worker thread that is requesting the operation.
        Returns:
        The next operation that should be processed, or null if the server is shutting down and no more operations will be processed.

      • removeOperation

        public boolean removeOperation​(Operation operation)
        Attempts to remove the specified operation from this queue if it has not yet been picked up for processing by one of the worker threads.
        Parameters:
        operation - The operation to remove from the queue.
        Returns:
        true if the provided request was present in the queue and was removed successfully, or false it not.

      • getOpsSubmitted

        public long getOpsSubmitted()
        Retrieves the total number of operations that have been successfully submitted to this work queue for processing since server startup. This does not include operations that have been rejected for some reason like the queue already at its maximum capacity.
        Returns:
        The total number of operations that have been successfully submitted to this work queue since startup.

      • size

        public int size()
        Retrieves the number of pending operations in the queue that have not yet been picked up for processing. Note that this method is not a constant-time operation and can be relatively inefficient, so it should be used sparingly.
        Returns:
        The number of pending operations in the queue that have not yet been picked up for processing.

      • isConfigurationChangeAcceptable

        public boolean isConfigurationChangeAcceptable​(ParallelWorkQueueCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
        Description copied from interface: ConfigurationChangeListener
        Indicates whether the proposed change to the configuration is acceptable to this change listener.
        Specified by:
        isConfigurationChangeAcceptable in interface ConfigurationChangeListener<ParallelWorkQueueCfg>
        Parameters:
        configuration - The new configuration containing the changes.
        unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
        Returns:
        Returns true if the proposed change is acceptable, or false if it is not.

      • isIdle

        public boolean isIdle()
        Description copied from class: WorkQueue
        Indicates whether the work queue is currently processing any requests. Note that this is a point-in-time determination, and if any component of the server wishes to depend on a quiescent state then it should use some external mechanism to ensure that no other requests are submitted to the queue.
        Specified by:
        isIdle in class WorkQueue<ParallelWorkQueueCfg>
        Returns:
        true if the work queue is currently idle, or false if it is being used to process one or more operations.

      • getNumWorkerThreads

        public int getNumWorkerThreads()
        Return the number of worker threads used by this WorkQueue.
        Specified by:
        getNumWorkerThreads in class WorkQueue<ParallelWorkQueueCfg>
        Returns:
        the number of worker threads used by this WorkQueue