com.j_spaces.jms
Class GSTopicPublisherImpl

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

All Implemented Interfaces:

MessageProducer, TopicPublisher

public class GSTopicPublisherImpl
extends GSMessageProducerImpl
implements TopicPublisher

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, String producerKey)
Constructs a publisher.

Method Summary

void	close() Close the publisher
Topic	getTopic() API method.
void	publish(Message message) API method.
void	publish(Message message, int deliveryMode, int priority, long timeToLive) API method.
void	publish(Topic topic, Message message) API method.
void	publish(Topic topic, Message message, int deliveryMode, int priority, long timeToLive) API method.

Methods inherited from class com.j_spaces.jms.GSMessageProducerImpl

getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getProducerID, getTimeToLive, isClosed, send, send, send, send, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive, start, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jms.MessageProducer

getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, send, send, send, send, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive

Constructor Detail

GSTopicPublisherImpl

public GSTopicPublisherImpl(GSSessionImpl sess,
                            GSTopicImpl topic,
                            String producerKey)
                     throws JMSException

Constructs a publisher.

Parameters:

sess - The session the publisher belongs to.

topic - The topic the publisher publishs messages on.

producerKey -

Throws:

IllegalStateException - If the connection is broken.

JMSException - If the creation fails for any other reason.

Method Detail

getTopic

public Topic getTopic()
               throws JMSException

API method.

Specified by:

getTopic in interface TopicPublisher

Returns:

Topic topic

Throws:

IllegalStateException - If the publisher is closed.

JMSException

publish

public void publish(Message message)
             throws JMSException

API method. Publishes a message to the topic. Uses the TopicPublisher's default delivery mode, priority, and time to live. Calls the GSMessageProducerImpl.send()

Specified by:

publish in interface TopicPublisher

Parameters:

message -

Throws:

IllegalStateException - If the publisher is closed, or if the connection is broken.

JMSException - If the request fails for any other reason.

See Also:

MessageProducer.getDeliveryMode(), MessageProducer.getTimeToLive(), MessageProducer.getPriority()

publish

public void publish(Message message,
                    int deliveryMode,
                    int priority,
                    long timeToLive)
             throws JMSException

API method. Publishes a message to the topic, specifying delivery mode, priority, and time to live. Calls the GSMessageProducerImpl.send()

Specified by:

publish in interface TopicPublisher

Parameters:

message -

deliveryMode -

priority -

timeToLive -

Throws:

IllegalStateException - If the publisher is closed, or if the connection is broken.

JMSException - If the request fails for any other reason.

publish

public void publish(Topic topic,
                    Message message)
             throws JMSException

API method. Publishes a message to a topic for an unidentified message producer. Uses the TopicPublisher's default delivery mode, priority, and time to live.

Typically, a message producer is assigned a topic at creation time; however, the JMS API also supports unidentified message producers, which require that the topic be supplied every time a message is published. Calls the GSMessageProducerImpl.send()

Specified by:

publish in interface TopicPublisher

Parameters:

topic - the topic to publish this message to

message -

Throws:

IllegalStateException - If the publisher is closed, or if the connection is broken.

JMSException - If the request fails for any other reason.

publish

public void publish(Topic topic,
                    Message message,
                    int deliveryMode,
                    int priority,
                    long timeToLive)
             throws JMSException

API method. Publishes a message to a topic for an unidentified message producer, specifying delivery mode, priority and time to live.

Typically, a message producer is assigned a topic at creation time; however, the JMS API also supports unidentified message producers, which require that the topic be supplied every time a message is published.

Specified by:

publish in interface TopicPublisher

Parameters:

topic - the topic to publish this message to

message -

deliveryMode -

priority -

timeToLive -

Throws:

IllegalStateException - If the publisher is closed, or if the connection is broken.

JMSException - If the request fails for any other reason.

close

public void close()
           throws JMSException

Close the publisher

Specified by:

close in interface MessageProducer

Overrides:

close in class GSMessageProducerImpl

Throws:

JMSException - if the publisher can't be closed

See Also:

MessageProducer.close()