Java 2 Platform EE v1.3: Interface Topic - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.jms
Interface Topic

All Superinterfaces:: Destination

All Known Subinterfaces:: TemporaryTopic

public interface Topic
extends Destination

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.

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:: TopicSession.createTopic(String)

Method Summary

java.lang.String getTopicName()
Gets the name of this topic.

java.lang.String toString()
Returns a string representation of this object.

Method Detail

getTopicName

public java.lang.String getTopicName()
                              throws JMSException

Gets the name of this topic.

Clients that depend upon the name are not portable.

Returns:: the topic name
Throws:: JMSException - if the JMS provider implementation of Topic fails to return the topic name due to some internal error.

toString

public java.lang.String toString()

Returns a string representation of this object.

Overrides:: toString in class java.lang.Object

Returns:: the provider-specific identity values for this topic