javax.jms.TemporaryTopic 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: TemporaryTopic.java 6347 2013-03-13 08:52:02Z tachker $
 *  ---------------------------------------------------------------------
 */

package javax.jms;

/**
 * A {@code TemporaryTopic} object is a unique {@code Topic} object created for
 * the duration of a {@code Connection}. It is a system-defined topic that can be
 * consumed only by the {@code Connection} that created it.
 * 
 * @see Session#createTemporaryTopic()
 * @see TopicSession#createTemporaryTopic()
 * 
 * @version JMS 2.0
 * @since JMS 1.0
 * 
 */

public interface TemporaryTopic extends Topic {

  /**
   * Deletes this temporary topic. If there are existing subscribers still using
   * it, a {@code JMSException} will be thrown.
   * 
   * @exception JMSException
   *              if the JMS provider fails to delete the temporary topic due to
   *              some internal error.
   */

  void delete() throws JMSException;
}