org.codehaus.activemq.message
Class ActiveMQTopic

java.lang.Object
  org.codehaus.activemq.jndi.JNDIBaseStorable
      org.codehaus.activemq.message.ActiveMQDestination
          org.codehaus.activemq.message.ActiveMQTopic

All Implemented Interfaces:

java.lang.Comparable, Destination, JNDIStorableInterface, javax.naming.Referenceable, java.io.Serializable, Topic

Direct Known Subclasses:

ActiveMQTemporaryTopic

public class ActiveMQTopic

extends ActiveMQDestination

implements Topic

A Topic object encapsulates a provider-specific topic name. It is the way a client specifies the identity of a topic to JMS API methods. For those methods that use a Destination as a parameter, a Topic object may used as an argument . For example, a Topic can be used to create a MessageConsumer and a MessageProducer by calling:

• Session.CreateConsumer(Destination destination)
• Session.CreateProducer(Destination destination)

Many publish/subscribe (pub/sub) providers group topics into hierarchies and provide various options for subscribing to parts of the hierarchy. The JMS API places no restriction on what a Topic object represents. It may be a leaf in a topic hierarchy, or it may be a larger part of the hierarchy.

The organization of topics and the granularity of subscriptions to them is an important part of a pub/sub application's architecture. The JMS API does not specify a policy for how this should be done. If an application takes advantage of a provider-specific topic-grouping mechanism, it should document this. If the application is installed using a different provider, it is the job of the administrator to construct an equivalent topic architecture and create equivalent Topic objects.

See Also:

Session.createConsumer(javax.jms.Destination), Session.createProducer(javax.jms.Destination), TopicSession.createTopic(String), Serialized Form

Field Summary

Fields inherited from class org.codehaus.activemq.message.ActiveMQDestination

ACTIVEMQ_QUEUE, ACTIVEMQ_TEMPORARY_QUEUE, ACTIVEMQ_TEMPORARY_TOPIC, ACTIVEMQ_TOPIC

Constructor Summary

ActiveMQTopic()
Default constructor for an ActiveMQTopic Destination

ActiveMQTopic(java.lang.String name)
Construct a named ActiveMQTopic Destination

Method Summary

int	getDestinationType()
java.lang.String	getTopicName() Gets the name of this Topic.

Methods inherited from class org.codehaus.activemq.message.ActiveMQDestination

buildFromProperties, compareTo, compareTo, createTemporaryName, equals, getClientId, getPhysicalName, hashCode, inspect, isQueue, isTemporary, isTopic, isWildcard, populateProperties, readFromStream, setPhysicalName, toString, transformDestination, writeToStream

Methods inherited from class org.codehaus.activemq.jndi.JNDIBaseStorable

getProperties, getReference, setProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jms.Topic

toString

Constructor Detail

ActiveMQTopic

public ActiveMQTopic()

Default constructor for an ActiveMQTopic Destination

ActiveMQTopic

public ActiveMQTopic(java.lang.String name)

Construct a named ActiveMQTopic Destination

Parameters:

name -

Method Detail

getTopicName

public java.lang.String getTopicName()

Gets the name of this Topic.

Clients that depend upon the name are not portable.

Specified by:

getTopicName in interface Topic

Returns:

the Topic name

getDestinationType

public int getDestinationType()

Specified by:

getDestinationType in class ActiveMQDestination

Returns:

Returns the Destination type