Package org.apache.activemq.artemis.jms.client

Class ActiveMQDestination

java.lang.Object

org.apache.activemq.artemis.jndi.JNDIStorable

org.apache.activemq.artemis.jms.client.ActiveMQDestination

All Implemented Interfaces:

jakarta.jms.Destination, Serializable, Referenceable

Direct Known Subclasses:

ActiveMQQueue, ActiveMQTopic

public class ActiveMQDestination
extends JNDIStorable
implements jakarta.jms.Destination, Serializable

ActiveMQ Artemis implementation of a JMS Destination.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ActiveMQDestination.TYPE

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QUEUE_QUALIFIED_PREFIX
static final String	TEMP_QUEUE_QUALIFED_PREFIX
static final String	TEMP_TOPIC_QUALIFED_PREFIX
static final String	TOPIC_QUALIFIED_PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActiveMQDestination(String address, String name, ActiveMQDestination.TYPE type, ActiveMQSession session)
protected	ActiveMQDestination(String address, ActiveMQDestination.TYPE type, ActiveMQSession session)
protected	ActiveMQDestination(SimpleString address, String name, ActiveMQDestination.TYPE type, ActiveMQSession session)	Deprecated.
protected	ActiveMQDestination(SimpleString address, ActiveMQDestination.TYPE type, ActiveMQSession session)

Method Summary

Modifier and Type	Method	Description
protected void	buildFromProperties(Properties props)	Set the properties that will represent the instance in JNDI
static ActiveMQDestination	createDestination(String name, ActiveMQDestination.TYPE defaultType)	Static helper method for working with destinations.
static ActiveMQDestination	createDestination(RoutingType routingType, SimpleString address)
static ActiveMQQueue	createQueue(String address)
static ActiveMQQueue	createQueue(String address, String name)
static ActiveMQQueue	createQueue(SimpleString address)
static SimpleString	createQueueAddressFromName(String name)
static String	createQueueNameForSharedSubscription(boolean isDurable, String clientID, String subscriptionName)
static SimpleString	createQueueNameForSubscription(boolean isDurable, String clientID, String subscriptionName)
static ActiveMQTemporaryQueue	createTemporaryQueue(String address)
static ActiveMQTemporaryQueue	createTemporaryQueue(String address, ActiveMQSession session)
static ActiveMQTemporaryQueue	createTemporaryQueue(ActiveMQSession session)
static ActiveMQTemporaryQueue	createTemporaryQueue(ActiveMQSession session, String prefix)
static ActiveMQTemporaryTopic	createTemporaryTopic(String address)
static ActiveMQTemporaryTopic	createTemporaryTopic(String address, ActiveMQSession session)
static ActiveMQTemporaryTopic	createTemporaryTopic(ActiveMQSession session)
static ActiveMQTemporaryTopic	createTemporaryTopic(ActiveMQSession session, String prefix)
static ActiveMQTopic	createTopic(String address)
static ActiveMQTopic	createTopic(String address, String name)
static ActiveMQTopic	createTopic(SimpleString address)
static SimpleString	createTopicAddressFromName(String name)
static Pair<String,String>	decomposeQueueNameForDurableSubscription(String queueName)
void	delete()
boolean	equals(Object o)
static jakarta.jms.Destination	fromPrefixed1XName(String addr, String name)
static ActiveMQDestination	fromPrefixedName(String name)
static ActiveMQDestination	fromPrefixedName(String addr, String name)
String	getAddress()
boolean	getCreated()
String	getName()
QueueAttributes	getQueueAttributes()	Deprecated.
QueueConfiguration	getQueueConfiguration()
SimpleString	getSimpleAddress()
ActiveMQDestination.TYPE	getType()
int	hashCode()
boolean	isCreated()
boolean	isQueue()
boolean	isTemporary()
protected void	populateProperties(Properties props)	Initialize the instance from properties stored in JNDI
void	setAddress(String address)
void	setCreated(boolean created)
void	setCreated(String created)
void	setSimpleAddress(String address)
void	setSimpleAddress(SimpleString address)
String	toString()

Methods inherited from class org.apache.activemq.artemis.jndi.JNDIStorable

getReference, readObject, writeObject

Methods inherited from class java.lang.Object

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

Field Details

QUEUE_QUALIFIED_PREFIX

public static final String QUEUE_QUALIFIED_PREFIX

See Also:

• Constant Field Values

TOPIC_QUALIFIED_PREFIX

public static final String TOPIC_QUALIFIED_PREFIX

See Also:

• Constant Field Values

TEMP_QUEUE_QUALIFED_PREFIX

public static final String TEMP_QUEUE_QUALIFED_PREFIX

See Also:

• Constant Field Values

TEMP_TOPIC_QUALIFED_PREFIX

public static final String TEMP_TOPIC_QUALIFED_PREFIX

See Also:

• Constant Field Values

Constructor Details

ActiveMQDestination

protected ActiveMQDestination(String address,
 ActiveMQDestination.TYPE type,
 ActiveMQSession session)

ActiveMQDestination

protected ActiveMQDestination(SimpleString address,
 ActiveMQDestination.TYPE type,
 ActiveMQSession session)

ActiveMQDestination

protected ActiveMQDestination(String address,
 String name,
 ActiveMQDestination.TYPE type,
 ActiveMQSession session)

ActiveMQDestination

@Deprecated
protected ActiveMQDestination(SimpleString address,
 String name,
 ActiveMQDestination.TYPE type,
 ActiveMQSession session)

Deprecated.

Method Details

createDestination

public static ActiveMQDestination createDestination(RoutingType routingType,
 SimpleString address)

createDestination

public static ActiveMQDestination createDestination(String name,
 ActiveMQDestination.TYPE defaultType)

Static helper method for working with destinations.

fromPrefixedName

public static ActiveMQDestination fromPrefixedName(String name)

fromPrefixedName

public static ActiveMQDestination fromPrefixedName(String addr,
 String name)

fromPrefixed1XName

public static jakarta.jms.Destination fromPrefixed1XName(String addr,
 String name)

createQueueNameForSubscription

public static SimpleString createQueueNameForSubscription(boolean isDurable,
 String clientID,
 String subscriptionName)

createQueueNameForSharedSubscription

public static String createQueueNameForSharedSubscription(boolean isDurable,
 String clientID,
 String subscriptionName)

decomposeQueueNameForDurableSubscription

public static Pair<String,String> decomposeQueueNameForDurableSubscription(String queueName)

createQueueAddressFromName

public static SimpleString createQueueAddressFromName(String name)

createTopicAddressFromName

public static SimpleString createTopicAddressFromName(String name)

createQueue

public static ActiveMQQueue createQueue(String address)

createQueue

public static ActiveMQQueue createQueue(SimpleString address)

createQueue

public static ActiveMQQueue createQueue(String address,
 String name)

createTopic

public static ActiveMQTopic createTopic(String address)

createTopic

public static ActiveMQTopic createTopic(SimpleString address)

createTopic

public static ActiveMQTopic createTopic(String address,
 String name)

createTemporaryQueue

public static ActiveMQTemporaryQueue createTemporaryQueue(String address,
 ActiveMQSession session)

createTemporaryQueue

public static ActiveMQTemporaryQueue createTemporaryQueue(String address)

createTemporaryQueue

public static ActiveMQTemporaryQueue createTemporaryQueue(ActiveMQSession session)

createTemporaryTopic

public static ActiveMQTemporaryTopic createTemporaryTopic(ActiveMQSession session)

createTemporaryQueue

public static ActiveMQTemporaryQueue createTemporaryQueue(ActiveMQSession session,
 String prefix)

createTemporaryTopic

public static ActiveMQTemporaryTopic createTemporaryTopic(ActiveMQSession session,
 String prefix)

createTemporaryTopic

public static ActiveMQTemporaryTopic createTemporaryTopic(String address,
 ActiveMQSession session)

createTemporaryTopic

public static ActiveMQTemporaryTopic createTemporaryTopic(String address)

setAddress

public void setAddress(String address)

toString

public String toString()

Overrides:

toString in class Object

setSimpleAddress

public void setSimpleAddress(SimpleString address)

setSimpleAddress

public void setSimpleAddress(String address)

delete

public void delete()
            throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

isQueue

public boolean isQueue()

getAddress

public String getAddress()

getSimpleAddress

public SimpleString getSimpleAddress()

getQueueAttributes

@Deprecated
public QueueAttributes getQueueAttributes()

Deprecated.

getQueueConfiguration

public QueueConfiguration getQueueConfiguration()

getName

public String getName()

isTemporary

public boolean isTemporary()

getCreated

public boolean getCreated()

isCreated

public boolean isCreated()

setCreated

public void setCreated(boolean created)

setCreated

public void setCreated(String created)

getType

public ActiveMQDestination.TYPE getType()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

buildFromProperties

protected void buildFromProperties(Properties props)

Description copied from class: JNDIStorable

Set the properties that will represent the instance in JNDI

Specified by:

buildFromProperties in class JNDIStorable

Parameters:

props - The properties to use when building the new isntance.

populateProperties

protected void populateProperties(Properties props)

Description copied from class: JNDIStorable

Initialize the instance from properties stored in JNDI

Specified by:

populateProperties in class JNDIStorable

Parameters:

props - The properties to use when initializing the new instance.