Package org.opends.server.extensions

Class TraditionalWorkQueue

java.lang.Object
org.opends.server.api.WorkQueue<TraditionalWorkQueueCfg>
org.opends.server.extensions.TraditionalWorkQueue
All Implemented Interfaces:
Executor, ConfigurationChangeListener<TraditionalWorkQueueCfg>
public final class TraditionalWorkQueue extends WorkQueue<TraditionalWorkQueueCfg> implements ConfigurationChangeListener<TraditionalWorkQueueCfg>
This class defines a data structure for storing and interacting with the Directory Server work queue.

  • Constructor Details

    • TraditionalWorkQueue

      public TraditionalWorkQueue()
      Creates a new instance of this work queue.

  • Method Details

    • initializeWorkQueue

      public void initializeWorkQueue(TraditionalWorkQueueCfg configuration, ServerContext serverContext)
      Description copied from class: WorkQueue
      Initializes this work queue based on the information in the provided configuration entry.
      Specified by:
      initializeWorkQueue in class WorkQueue<TraditionalWorkQueueCfg>
      Parameters:
      configuration - The configuration to use to initialize the work queue.
      serverContext - The server context.

    • finalizeWorkQueue

      public void finalizeWorkQueue(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<TraditionalWorkQueueCfg>
      Parameters:
      reason - The human-readable reason that the work queue is being shut down.

    • execute

      public void execute(Runnable command)
      Description copied from class: WorkQueue
      Submits a request to be processed in the server.
      Specified by:
      execute in interface Executor
      Specified by:
      execute in class WorkQueue<TraditionalWorkQueueCfg>
      Parameters:
      command - The request to be processed.

    • isConfigurationChangeAcceptable

      public boolean isConfigurationChangeAcceptable(TraditionalWorkQueueCfg configuration, List<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<TraditionalWorkQueueCfg>
      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.

    • applyConfigurationChange

      public ConfigChangeResult applyConfigurationChange(TraditionalWorkQueueCfg configuration)
      Description copied from interface: ConfigurationChangeListener
      Applies the configuration changes to this change listener.
      Specified by:
      applyConfigurationChange in interface ConfigurationChangeListener<TraditionalWorkQueueCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      Returns:
      Returns information about the result of changing the configuration.

    • 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<TraditionalWorkQueueCfg>
      Returns:
      true if the work queue is currently idle, or false if it is being used to process one or more operations.