Package com.pushtechnology.diffusion.api.config

Interface QueuesConfig

All Superinterfaces:
Config
public interface QueuesConfig extends Config
Configuration of Client Queue Definitions.

Queue definitions may not be changed side once the server has started.

If no queue definitions have been configured before the server is started then two queue definitions will be automatically created. The first called "DefaultQueue" with a maximum depth of 1000, and the second called "LargeQueue" with a maximum depth of 100,000.

Since:
4.4

  • Method Details

    • setDefaultQueue

      void setDefaultQueue(String queueDefinition) throws ConfigException
      Sets the name of the default queue definition.

      If this is not explicitly set, the first queue definition configured will be used.

      Parameters:
      queueDefinition - the name of the default queue definition.
      Throws:
      ConfigException - if unable to set the property

    • getDefaultQueue

      String getDefaultQueue()
      Gets the name of the default queue definition.
      Returns:
      the name of the default queue definition which can be null if not specified or no queues defined.

    • getQueues

      List<QueueConfig> getQueues()
      Get the list of configured queue definitions.
      Returns:
      list of queue definitions which can be empty if none have been defined.

    • getQueue

      QueueConfig getQueue(String name)
      Get a named queue definition.

      Parameters:
      name - the queue definition name
      Returns:
      the queue definition or null if no such definition exists

    • addQueue

      QueueConfig addQueue(String name) throws ConfigException
      Add a queue definition.
      Parameters:
      name - the queue definition name.
      Returns:
      the queue definition configuration
      Throws:
      ConfigException - if unable to add a queue of the given name