Package org.apache.activemq.artemis.api.core

Class QueueConfiguration

  • All Implemented Interfaces:
    java.io.Serializable
    public class QueueConfiguration
extends java.lang.Object
implements java.io.Serializable
    This class holds all the properties required to configure a queue. The only strictly required property is name. Some defaults will be enforced for properties which are not explicitly set:

    • address : the value set for name
    • transient : false
    • temporary : false
    • durable : true
    • autoCreated : false
    • internal : false
    • configurationManaged : false

    See Also:
    Serialized Form

    • Method Detail

      • getId

        public java.lang.Long getId()

      • getAddress

        public SimpleString getAddress()
        Returns:
        the name of the address; if the address is null then return the value of getName().

      • setAddress

        public QueueConfiguration setAddress​(SimpleString address)
        Set the name. If the fully-qualified queue name is used then it will be parsed and the corresponding values for address and name will be set automatically. For example if "myAddress::myQueue" is passed then the resulting value for address will be "myAddress" and the value for name will be "myQueue".
        Parameters:
        address - the address to use
        Returns:
        this QueueConfiguration

      • setName

        public QueueConfiguration setName​(SimpleString name)
        Set the name. If the fully-qualified queue name is used then it will be parsed and the corresponding values for address and name will be set automatically. For example if "myAddress::myQueue" is passed then the resulting value for address will be "myAddress" and the value for name will be "myQueue".
        Parameters:
        name - the name to use
        Returns:
        this QueueConfiguration

      • setFilterString

        public QueueConfiguration setFilterString​(java.lang.String filterString)

      • isDurable

        public java.lang.Boolean isDurable()
        defaults to true
        Returns:

      • getMaxConsumers

        public java.lang.Integer getMaxConsumers()

      • setMaxConsumers

        public QueueConfiguration setMaxConsumers​(java.lang.Integer maxConsumers)

      • isExclusive

        public java.lang.Boolean isExclusive()

      • isLastValue

        public java.lang.Boolean isLastValue()

      • setLastValueKey

        public QueueConfiguration setLastValueKey​(java.lang.String lastValueKey)

      • isNonDestructive

        public java.lang.Boolean isNonDestructive()

      • setNonDestructive

        public QueueConfiguration setNonDestructive​(java.lang.Boolean nonDestructive)

      • isPurgeOnNoConsumers

        public java.lang.Boolean isPurgeOnNoConsumers()

      • setPurgeOnNoConsumers

        public QueueConfiguration setPurgeOnNoConsumers​(java.lang.Boolean purgeOnNoConsumers)

      • isEnabled

        public java.lang.Boolean isEnabled()

      • getConsumersBeforeDispatch

        public java.lang.Integer getConsumersBeforeDispatch()

      • setConsumersBeforeDispatch

        public QueueConfiguration setConsumersBeforeDispatch​(java.lang.Integer consumersBeforeDispatch)

      • getDelayBeforeDispatch

        public java.lang.Long getDelayBeforeDispatch()

      • setDelayBeforeDispatch

        public QueueConfiguration setDelayBeforeDispatch​(java.lang.Long delayBeforeDispatch)

      • getConsumerPriority

        public java.lang.Integer getConsumerPriority()

      • setConsumerPriority

        public QueueConfiguration setConsumerPriority​(java.lang.Integer consumerPriority)

      • isGroupRebalance

        public java.lang.Boolean isGroupRebalance()

      • setGroupRebalance

        public QueueConfiguration setGroupRebalance​(java.lang.Boolean groupRebalance)

      • isGroupRebalancePauseDispatch

        public java.lang.Boolean isGroupRebalancePauseDispatch()

      • setGroupRebalancePauseDispatch

        public QueueConfiguration setGroupRebalancePauseDispatch​(java.lang.Boolean groupRebalancePauseDispatch)

      • getGroupBuckets

        public java.lang.Integer getGroupBuckets()

      • setGroupBuckets

        public QueueConfiguration setGroupBuckets​(java.lang.Integer groupBuckets)

      • setGroupFirstKey

        public QueueConfiguration setGroupFirstKey​(java.lang.String groupFirstKey)

      • isAutoDelete

        public java.lang.Boolean isAutoDelete()

      • setAutoDelete

        public QueueConfiguration setAutoDelete​(java.lang.Boolean autoDelete)

      • getAutoDeleteDelay

        public java.lang.Long getAutoDeleteDelay()

      • setAutoDeleteDelay

        public QueueConfiguration setAutoDeleteDelay​(java.lang.Long autoDeleteDelay)

      • getAutoDeleteMessageCount

        public java.lang.Long getAutoDeleteMessageCount()

      • setAutoDeleteMessageCount

        public QueueConfiguration setAutoDeleteMessageCount​(java.lang.Long autoDeleteMessageCount)

      • getRingSize

        public java.lang.Long getRingSize()

      • isConfigurationManaged

        public java.lang.Boolean isConfigurationManaged()
        defaults to false
        Returns:

      • setConfigurationManaged

        public QueueConfiguration setConfigurationManaged​(java.lang.Boolean configurationManaged)

      • isTemporary

        public java.lang.Boolean isTemporary()
        defaults to false
        Returns:

      • isAutoCreateAddress

        public java.lang.Boolean isAutoCreateAddress()

      • setAutoCreateAddress

        public QueueConfiguration setAutoCreateAddress​(java.lang.Boolean autoCreateAddress)

      • isInternal

        public java.lang.Boolean isInternal()
        defaults to false
        Returns:

      • isTransient

        public java.lang.Boolean isTransient()
        defaults to false
        Returns:

      • isAutoCreated

        public java.lang.Boolean isAutoCreated()
        defaults to false
        Returns:

      • setAutoCreated

        public QueueConfiguration setAutoCreated​(java.lang.Boolean autoCreated)

      • toJSON

        public java.lang.String toJSON()
        This method returns a JSON-formatted String representation of this QueueConfiguration. It is a simple collection of key/value pairs. The keys used are referenced in set(String, String).
        Returns:
        a JSON-formatted String representation of this QueueConfiguration

      • fromJSON

        public static QueueConfiguration fromJSON​(java.lang.String jsonString)
        This method returns a QueueConfiguration created from the JSON-formatted input String. The input should be a simple object of key/value pairs. Valid keys are referenced in set(String, String).
        Parameters:
        jsonString -
        Returns:
        the QueueConfiguration created from the JSON-formatted input String

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object