javax.jms.Topic Maven / Gradle / Ivy
/*
* @(#)Topic.java 1.17 02/04/09
*
* Copyright 1997-2002 Sun Microsystems, Inc. All Rights Reserved.
*
* SUN PROPRIETARY/CONFIDENTIAL.
* This software is the proprietary information of Sun Microsystems, Inc.
* Use is subject to license terms.
*
*/
package javax.jms;
/** 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.
*
* @version 1.1 - February 2, 2002
* @author Mark Hapner
* @author Rich Burridge
* @author Kate Stout
*
* @see Session#createConsumer(Destination)
* @see Session#createProducer(Destination)
* @see javax.jms.TopicSession#createTopic(String)
*/
public interface Topic extends Destination {
/** Gets the name of this topic.
*
*
Clients that depend upon the name are not portable.
*
* @return the topic name
*
* @exception JMSException if the JMS provider implementation of
* Topic fails to return the topic
* name due to some internal
* error.
*/
String
getTopicName() throws JMSException;
/** Returns a string representation of this object.
*
* @return the provider-specific identity values for this topic
*/
String
toString();
}