com.j_spaces.jms
Class GSTopicPublisherImpl

java.lang.Object
  com.j_spaces.jms.GSMessageProducerImpl
      com.j_spaces.jms.GSTopicPublisherImpl

All Implemented Interfaces:

MessageProducer, QueueSender, TopicPublisher

public class GSTopicPublisherImpl
extends GSMessageProducerImpl

GigaSpaces implementation of the javax.jms.TopicPublisher interface. A client uses a GSTopicPublisherImpl object to publish messages on a topic. A GSTopicPublisherImpl object is the publish-subscribe form of a message producer.

Normally, the Topic is specified when a GSTopicPublisherImpl is created. In this case, an attempt to use the publish methods for an unidentified GSTopicPublisherImpl will throw a java.lang.UnsupportedOperationException.

If the GSTopicPublisherImpl is created with an unidentified Topic, an attempt to use the publish methods that assume that the Topic has been identified will throw a java.lang.UnsupportedOperationException.

During the execution of its publish method, a message must not be changed by other threads within the client. If the message is modified, the result of the publish is undefined.

After publishing a message, a client may retain and modify it without affecting the message that has been published. The same message object may be published multiple times.

The following message headers are set as part of publishing a message: JMSDestination, JMSDeliveryMode, JMSExpiration, JMSPriority, JMSMessageID and JMSTimeStamp. When the message is published, the values of these headers are ignored. After completion of the publish, the headers hold the values specified by the method publishing the message. It is possible for the publish method not to set JMSMessageID and JMSTimeStamp if the setting of these headers is explicitly disabled by the GSMessageProducerImpl.setDisableMessageID or GSMessageProducerImpl.setDisableMessageTimestamp method.

Creating a GSMessageProducerImpl provides the same features as creating a GSTopicPublisherImpl. A GSMessageProducerImpl object is recommended when creating new code. The GSTopicPublisherImpl is provided to support existing code.

Because GSTopicPublisherImpl inherits from GSMessageProducerImpl, it inherits the send methods that are a part of the GSMessageProducerImpl interface. Using the send methods will have the same effect as using the publish methods: they are functionally the same.

Constructor Summary

GSTopicPublisherImpl(GSSessionImpl sess, GSTopicImpl topic, IMessageConverter messageConverter)
Constructs a publisher.

Method Summary

Methods inherited from class com.j_spaces.jms.GSMessageProducerImpl

close, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getProducerID, getQueue, getTimeToLive, getTopic, publish, publish, publish, publish, send, send, send, send, send, send, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setProducerID, setTimeToLive, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GSTopicPublisherImpl

public GSTopicPublisherImpl(GSSessionImpl sess,
                            GSTopicImpl topic,
                            IMessageConverter messageConverter)
                     throws JMSException

Constructs a publisher.

Parameters:

sess - The session the publisher belongs to.

topic - The topic the publisher publishs messages on.

messageConverter -

Throws:

IllegalStateException - If the connection is broken.

JMSException - If the creation fails for any other reason.