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

Class QueueConfiguration

java.lang.Object

org.apache.activemq.artemis.api.core.QueueConfiguration

All Implemented Interfaces:

Serializable

public class QueueConfiguration
extends Object
implements 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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDRESS
static final String	AUTO_CREATE_ADDRESS
static final String	AUTO_CREATED
static final String	AUTO_DELETE
static final String	AUTO_DELETE_DELAY
static final String	AUTO_DELETE_MESSAGE_COUNT
static final String	CONFIGURATION_MANAGED
static final String	CONSUMER_PRIORITY
static final String	CONSUMERS_BEFORE_DISPATCH
static final String	DELAY_BEFORE_DISPATCH
static final String	DURABLE
static final String	ENABLED
static final String	EXCLUSIVE
static final String	FILTER_STRING
static final String	FQQN
static final String	GROUP_BUCKETS
static final String	GROUP_FIRST_KEY
static final String	GROUP_REBALANCE
static final String	GROUP_REBALANCE_PAUSE_DISPATCH
static final String	ID
static final String	INTERNAL
static final String	LAST_VALUE
static final String	LAST_VALUE_KEY
static final String	MAX_CONSUMERS
static final String	NAME
static final String	NON_DESTRUCTIVE
static final String	PURGE_ON_NO_CONSUMERS
static final String	RING_SIZE
static final String	ROUTING_TYPE
static final String	TEMPORARY
static final String	TRANSIENT
static final String	USER

Constructor Summary

Constructors

Constructor	Description
QueueConfiguration()	Deprecated, for removal: This API element is subject to removal in a future version. Use of(String) instead.
QueueConfiguration(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(String) instead.
QueueConfiguration(QueueConfiguration o)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(QueueConfiguration) instead.
QueueConfiguration(SimpleString name)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(SimpleString) instead.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static QueueConfiguration	fromJSON(String jsonString)	This method returns a QueueConfiguration created from the JSON-formatted input String.
SimpleString	getAddress()	Returns the name of the address; if the address is null then return the value of getName().
Long	getAutoDeleteDelay()
Long	getAutoDeleteMessageCount()
Integer	getConsumerPriority()
Integer	getConsumersBeforeDispatch()
Long	getDelayBeforeDispatch()
SimpleString	getFilterString()
Integer	getGroupBuckets()
SimpleString	getGroupFirstKey()
Long	getId()
SimpleString	getLastValueKey()
Integer	getMaxConsumers()
SimpleString	getName()
Long	getRingSize()
RoutingType	getRoutingType()
SimpleString	getUser()
int	hashCode()
Boolean	isAutoCreateAddress()
Boolean	isAutoCreated()	defaults to false
Boolean	isAutoDelete()
Boolean	isConfigurationManaged()	defaults to false
Boolean	isDurable()	defaults to true
Boolean	isEnabled()
Boolean	isExclusive()
Boolean	isFqqn()	Based on if the name or address uses FQQN when set defaults to false
Boolean	isGroupRebalance()
Boolean	isGroupRebalancePauseDispatch()
Boolean	isInternal()	defaults to false
Boolean	isLastValue()
Boolean	isNonDestructive()
Boolean	isPurgeOnNoConsumers()
Boolean	isTemporary()	defaults to false
Boolean	isTransient()	defaults to false
static QueueConfiguration	of(String name)	Instance factory which invokes setName(SimpleString)
static QueueConfiguration	of(QueueConfiguration queueConfiguration)	Returns the QueueConfiguration instance which is a copy of the input parameter.
static QueueConfiguration	of(SimpleString name)	Instance factory which invokes setName(SimpleString)
QueueConfiguration	set(String key, String value)	Set the value of a parameter based on its "key" String.
QueueConfiguration	setAddress(String address)	Converts the input String and invokes setAddress(SimpleString)
QueueConfiguration	setAddress(SimpleString address)	Set the address.
QueueConfiguration	setAutoCreateAddress(Boolean autoCreateAddress)
QueueConfiguration	setAutoCreated(Boolean autoCreated)
QueueConfiguration	setAutoDelete(Boolean autoDelete)
QueueConfiguration	setAutoDeleteDelay(Long autoDeleteDelay)
QueueConfiguration	setAutoDeleteMessageCount(Long autoDeleteMessageCount)
QueueConfiguration	setConfigurationManaged(Boolean configurationManaged)
QueueConfiguration	setConsumerPriority(Integer consumerPriority)
QueueConfiguration	setConsumersBeforeDispatch(Integer consumersBeforeDispatch)
QueueConfiguration	setDelayBeforeDispatch(Long delayBeforeDispatch)
QueueConfiguration	setDurable(Boolean durable)
QueueConfiguration	setEnabled(Boolean enabled)
QueueConfiguration	setExclusive(Boolean exclusive)
QueueConfiguration	setFilterString(String filterString)	Converts the String parameter to SimpleString and invokes setFilterString(SimpleString)
QueueConfiguration	setFilterString(SimpleString filterString)	This sets the SimpleString value that will be used to create a Filter for the Queue implementation on the broker.
QueueConfiguration	setGroupBuckets(Integer groupBuckets)
QueueConfiguration	setGroupFirstKey(String groupFirstKey)
QueueConfiguration	setGroupFirstKey(SimpleString groupFirstKey)
QueueConfiguration	setGroupRebalance(Boolean groupRebalance)
QueueConfiguration	setGroupRebalancePauseDispatch(Boolean groupRebalancePauseDispatch)
QueueConfiguration	setId(Long id)
QueueConfiguration	setInternal(Boolean internal)
QueueConfiguration	setLastValue(Boolean lastValue)
QueueConfiguration	setLastValueKey(String lastValueKey)
QueueConfiguration	setLastValueKey(SimpleString lastValueKey)
QueueConfiguration	setMaxConsumers(Integer maxConsumers)
QueueConfiguration	setName(String name)	Converts the input String and invokes setName(SimpleString)
QueueConfiguration	setName(SimpleString name)	Set the name.
QueueConfiguration	setNonDestructive(Boolean nonDestructive)
QueueConfiguration	setPurgeOnNoConsumers(Boolean purgeOnNoConsumers)
QueueConfiguration	setRingSize(Long ringSize)
QueueConfiguration	setRoutingType(RoutingType routingType)
QueueConfiguration	setTemporary(Boolean temporary)
QueueConfiguration	setTransient(Boolean _transient)
QueueConfiguration	setUser(String user)
QueueConfiguration	setUser(SimpleString user)
String	toJSON()	This method returns a JSON-formatted String representation of this QueueConfiguration.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

ADDRESS

public static final String ADDRESS

See Also:

• Constant Field Values

ROUTING_TYPE

public static final String ROUTING_TYPE

See Also:

• Constant Field Values

FILTER_STRING

public static final String FILTER_STRING

See Also:

• Constant Field Values

DURABLE

public static final String DURABLE

See Also:

• Constant Field Values

USER

public static final String USER

See Also:

• Constant Field Values

MAX_CONSUMERS

public static final String MAX_CONSUMERS

See Also:

• Constant Field Values

EXCLUSIVE

public static final String EXCLUSIVE

See Also:

• Constant Field Values

GROUP_REBALANCE

public static final String GROUP_REBALANCE

See Also:

• Constant Field Values

GROUP_REBALANCE_PAUSE_DISPATCH

public static final String GROUP_REBALANCE_PAUSE_DISPATCH

See Also:

• Constant Field Values

GROUP_BUCKETS

public static final String GROUP_BUCKETS

See Also:

• Constant Field Values

GROUP_FIRST_KEY

public static final String GROUP_FIRST_KEY

See Also:

• Constant Field Values

LAST_VALUE

public static final String LAST_VALUE

See Also:

• Constant Field Values

LAST_VALUE_KEY

public static final String LAST_VALUE_KEY

See Also:

• Constant Field Values

NON_DESTRUCTIVE

public static final String NON_DESTRUCTIVE

See Also:

• Constant Field Values

PURGE_ON_NO_CONSUMERS

public static final String PURGE_ON_NO_CONSUMERS

See Also:

• Constant Field Values

ENABLED

public static final String ENABLED

See Also:

• Constant Field Values

CONSUMERS_BEFORE_DISPATCH

public static final String CONSUMERS_BEFORE_DISPATCH

See Also:

• Constant Field Values

DELAY_BEFORE_DISPATCH

public static final String DELAY_BEFORE_DISPATCH

See Also:

• Constant Field Values

CONSUMER_PRIORITY

public static final String CONSUMER_PRIORITY

See Also:

• Constant Field Values

AUTO_DELETE

public static final String AUTO_DELETE

See Also:

• Constant Field Values

AUTO_DELETE_DELAY

public static final String AUTO_DELETE_DELAY

See Also:

• Constant Field Values

AUTO_DELETE_MESSAGE_COUNT

public static final String AUTO_DELETE_MESSAGE_COUNT

See Also:

• Constant Field Values

RING_SIZE

public static final String RING_SIZE

See Also:

• Constant Field Values

CONFIGURATION_MANAGED

public static final String CONFIGURATION_MANAGED

See Also:

• Constant Field Values

TEMPORARY

public static final String TEMPORARY

See Also:

• Constant Field Values

AUTO_CREATE_ADDRESS

public static final String AUTO_CREATE_ADDRESS

See Also:

• Constant Field Values

INTERNAL

public static final String INTERNAL

See Also:

• Constant Field Values

TRANSIENT

public static final String TRANSIENT

See Also:

• Constant Field Values

AUTO_CREATED

public static final String AUTO_CREATED

See Also:

• Constant Field Values

FQQN

public static final String FQQN

See Also:

• Constant Field Values

Constructor Details

QueueConfiguration

@Deprecated(forRemoval=true)
public QueueConfiguration()

Deprecated, for removal: This API element is subject to removal in a future version.

Use of(String) instead.

QueueConfiguration

@Deprecated(forRemoval=true)
public QueueConfiguration(QueueConfiguration o)

Deprecated, for removal: This API element is subject to removal in a future version.

Use of(QueueConfiguration) instead.

Parameters:

o - create a copy of this

QueueConfiguration

@Deprecated(forRemoval=true)
public QueueConfiguration(SimpleString name)

Deprecated, for removal: This API element is subject to removal in a future version.

Use of(SimpleString) instead.

Instantiate this object and invoke setName(SimpleString)

Parameters:

name - the name to use for the queue

See Also:

• setName(SimpleString)

QueueConfiguration

@Deprecated(forRemoval=true)
public QueueConfiguration(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

Use of(String) instead.

Instantiate this object and invoke setName(SimpleString)

Parameters:

name - the name to use for the queue

See Also:

• setName(SimpleString)

Method Details

of

public static QueueConfiguration of(String name)

Instance factory which invokes setName(SimpleString)

Parameters:

name - the name to use for the queue

See Also:

• setName(SimpleString)

of

public static QueueConfiguration of(SimpleString name)

Instance factory which invokes setName(SimpleString)

Parameters:

name - the name to use for the queue

See Also:

• setName(SimpleString)

of

public static QueueConfiguration of(QueueConfiguration queueConfiguration)

Returns the QueueConfiguration instance which is a copy of the input parameter.

Returns:

the QueueConfiguration instance which is a copy of the input parameter

set

public QueueConfiguration set(String key,
 String value)

Set the value of a parameter based on its "key" String. Valid key names and corresponding static final are:

• id: ID
• name: NAME
• address: ADDRESS
• routing-type: ROUTING_TYPE
• filter-string: FILTER_STRING
• durable: DURABLE
• user: USER
• max-consumers: MAX_CONSUMERS
• exclusive: EXCLUSIVE
• group-rebalance: GROUP_REBALANCE
• group-rebalance-pause-dispatch: GROUP_REBALANCE_PAUSE_DISPATCH
• group-buckets: GROUP_BUCKETS
• group-first-key: GROUP_FIRST_KEY
• last-value: LAST_VALUE
• last-value-key: LAST_VALUE_KEY
• non-destructive: NON_DESTRUCTIVE
• purge-on-no-consumers: PURGE_ON_NO_CONSUMERS
• consumers-before-dispatch: CONSUMERS_BEFORE_DISPATCH
• delay-before-dispatch: DELAY_BEFORE_DISPATCH
• consumer-priority: CONSUMER_PRIORITY
• auto-delete: AUTO_DELETE
• auto-delete-delay: AUTO_DELETE_DELAY
• auto-delete-message-count: AUTO_DELETE_MESSAGE_COUNT
• ring-size: RING_SIZE
• configuration-managed: ID
• temporary: TEMPORARY
• auto-create-address: AUTO_CREATE_ADDRESS
• internal: INTERNAL
• transient: TRANSIENT
• auto-created: AUTO_CREATED

The String-based values will be converted to the proper value types based on the underlying property. For example, if you pass the value "TRUE" for the key "auto-created" the String "TRUE" will be converted to the Boolean true.

Parameters:

key - the key to set to the value

value - the value to set for the key

Returns:

this QueueConfiguration

getId

public Long getId()

setId

public QueueConfiguration setId(Long id)

getAddress

public SimpleString getAddress()

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

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

setAddress

public QueueConfiguration setAddress(String address)

Converts the input String and invokes setAddress(SimpleString)

See Also:

• setAddress(SimpleString)

getName

public SimpleString getName()

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

setName

public QueueConfiguration setName(String name)

Converts the input String and invokes setName(SimpleString)

See Also:

• setName(SimpleString)

getRoutingType

public RoutingType getRoutingType()

setRoutingType

public QueueConfiguration setRoutingType(RoutingType routingType)

getFilterString

public SimpleString getFilterString()

setFilterString

public QueueConfiguration setFilterString(SimpleString filterString)

This sets the SimpleString value that will be used to create a Filter for the Queue implementation on the broker. The filter's syntax is not validated here.

Parameters:

filterString - the filter to use; an empty value or a value filled with whitespace is equivalent to passing null

Returns:

this QueueConfiguration

setFilterString

public QueueConfiguration setFilterString(String filterString)

Converts the String parameter to SimpleString and invokes setFilterString(SimpleString)

See Also:

• setFilterString(SimpleString)

isDurable

public Boolean isDurable()

defaults to true

setDurable

public QueueConfiguration setDurable(Boolean durable)

getUser

public SimpleString getUser()

setUser

public QueueConfiguration setUser(SimpleString user)

setUser

public QueueConfiguration setUser(String user)

getMaxConsumers

public Integer getMaxConsumers()

setMaxConsumers

public QueueConfiguration setMaxConsumers(Integer maxConsumers)

isExclusive

public Boolean isExclusive()

setExclusive

public QueueConfiguration setExclusive(Boolean exclusive)

isLastValue

public Boolean isLastValue()

setLastValue

public QueueConfiguration setLastValue(Boolean lastValue)

getLastValueKey

public SimpleString getLastValueKey()

setLastValueKey

public QueueConfiguration setLastValueKey(SimpleString lastValueKey)

setLastValueKey

public QueueConfiguration setLastValueKey(String lastValueKey)

isNonDestructive

public Boolean isNonDestructive()

setNonDestructive

public QueueConfiguration setNonDestructive(Boolean nonDestructive)

isPurgeOnNoConsumers

public Boolean isPurgeOnNoConsumers()

setPurgeOnNoConsumers

public QueueConfiguration setPurgeOnNoConsumers(Boolean purgeOnNoConsumers)

isEnabled

public Boolean isEnabled()

setEnabled

public QueueConfiguration setEnabled(Boolean enabled)

getConsumersBeforeDispatch

public Integer getConsumersBeforeDispatch()

setConsumersBeforeDispatch

public QueueConfiguration setConsumersBeforeDispatch(Integer consumersBeforeDispatch)

getDelayBeforeDispatch

public Long getDelayBeforeDispatch()

setDelayBeforeDispatch

public QueueConfiguration setDelayBeforeDispatch(Long delayBeforeDispatch)

getConsumerPriority

public Integer getConsumerPriority()

setConsumerPriority

public QueueConfiguration setConsumerPriority(Integer consumerPriority)

isGroupRebalance

public Boolean isGroupRebalance()

setGroupRebalance

public QueueConfiguration setGroupRebalance(Boolean groupRebalance)

isGroupRebalancePauseDispatch

public Boolean isGroupRebalancePauseDispatch()

setGroupRebalancePauseDispatch

public QueueConfiguration setGroupRebalancePauseDispatch(Boolean groupRebalancePauseDispatch)

getGroupBuckets

public Integer getGroupBuckets()

setGroupBuckets

public QueueConfiguration setGroupBuckets(Integer groupBuckets)

getGroupFirstKey

public SimpleString getGroupFirstKey()

setGroupFirstKey

public QueueConfiguration setGroupFirstKey(SimpleString groupFirstKey)

setGroupFirstKey

public QueueConfiguration setGroupFirstKey(String groupFirstKey)

isAutoDelete

public Boolean isAutoDelete()

setAutoDelete

public QueueConfiguration setAutoDelete(Boolean autoDelete)

getAutoDeleteDelay

public Long getAutoDeleteDelay()

setAutoDeleteDelay

public QueueConfiguration setAutoDeleteDelay(Long autoDeleteDelay)

getAutoDeleteMessageCount

public Long getAutoDeleteMessageCount()

setAutoDeleteMessageCount

public QueueConfiguration setAutoDeleteMessageCount(Long autoDeleteMessageCount)

getRingSize

public Long getRingSize()

setRingSize

public QueueConfiguration setRingSize(Long ringSize)

isConfigurationManaged

public Boolean isConfigurationManaged()

defaults to false

setConfigurationManaged

public QueueConfiguration setConfigurationManaged(Boolean configurationManaged)

isTemporary

public Boolean isTemporary()

defaults to false

setTemporary

public QueueConfiguration setTemporary(Boolean temporary)

isAutoCreateAddress

public Boolean isAutoCreateAddress()

setAutoCreateAddress

public QueueConfiguration setAutoCreateAddress(Boolean autoCreateAddress)

isInternal

public Boolean isInternal()

defaults to false

setInternal

public QueueConfiguration setInternal(Boolean internal)

isTransient

public Boolean isTransient()

defaults to false

setTransient

public QueueConfiguration setTransient(Boolean _transient)

isAutoCreated

public Boolean isAutoCreated()

defaults to false

setAutoCreated

public QueueConfiguration setAutoCreated(Boolean autoCreated)

isFqqn

public Boolean isFqqn()

Based on if the name or address uses FQQN when set defaults to false

toJSON

public 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(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).

Returns:

the QueueConfiguration created from the JSON-formatted input String

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object