javax.jms.TopicSubscriber Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ow2-jms-2.0-spec Show documentation
The Java Message Service (JMS) API, version 2.0
The newest version!
/**
 * Copyright 2013 ScalAgent Distributed Technologies
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  ---------------------------------------------------------------------
 *  $Id: TopicSubscriber.java 6347 2013-03-13 08:52:02Z tachker $
 *  ---------------------------------------------------------------------
 */

package javax.jms;

/**
 * A client uses a {@code TopicSubscriber} object to receive messages that have
 * been published to a topic. A {@code TopicSubscriber} object is the
 * publish/subscribe form of a message consumer. A {@code MessageConsumer} can be
 * instantiated by using {@code Session.createConsumer}.
 * 
 * @see javax.jms.Session#createConsumer
 * @see javax.jms.Session#createDurableSubscriber
 * @see javax.jms.TopicSession
 * @see javax.jms.TopicSession#createSubscriber
 * @see javax.jms.MessageConsumer
 * 
 * @version JMS 2.0
 * @since JMS 1.0
 * 
 */

public interface TopicSubscriber extends MessageConsumer {

  /**
   * Gets the {@code Topic} associated with this subscriber.
   * 
   * @return this subscriber's {@code Topic}
   * 
   * @exception JMSException
   *              if the JMS provider fails to get the topic for this topic
   *              subscriber due to some internal error.
   */

  Topic getTopic() throws JMSException;

  /**
   * Gets the {@code NoLocal} attribute for this subscriber. The default value
   * for this attribute is false.
   * 
   * @return true if locally published messages are being inhibited
   * 
   * @exception JMSException
   *              if the JMS provider fails to get the {@code NoLocal} attribute
   *              for this topic subscriber due to some internal error.
   */

  boolean getNoLocal() throws JMSException;
}