com.j_spaces.jms
Class GSQueueSenderImpl

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

All Implemented Interfaces:

MessageProducer, QueueSender

public class GSQueueSenderImpl
extends GSMessageProducerImpl
implements QueueSender

GigaSpaces implementation of the javax.jms.Session interface. A client uses a GSQueueSenderImpl object to send messages to a queue.

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

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

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

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

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

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

See Also:

MessageProducer, Session.createProducer(Destination), QueueSession.createSender(Queue)

Constructor Summary

GSQueueSenderImpl(GSSessionImpl sess, GSQueueImpl queue, String producerKey)
Constructs a queue sender.

Method Summary

void	close() Close the sender
Queue	getQueue() API method.
void	send(Message message) Sends a message to the queue.
void	send(Queue queue, Message message) API method.
void	send(Queue queue, 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, 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.QueueSender

send

Methods inherited from interface javax.jms.MessageProducer

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

Constructor Detail

GSQueueSenderImpl

public GSQueueSenderImpl(GSSessionImpl sess,
                         GSQueueImpl queue,
                         String producerKey)
                  throws JMSException

Constructs a queue sender.

Parameters:

sess - The session the publisher belongs to.

queue - The queue the publisher publishs messages on.

producerKey -

Throws:

IllegalStateException - If the connection is broken.

JMSException - If the creation fails for any other reason.

Method Detail

getQueue

public Queue getQueue()
               throws JMSException

API method.

Specified by:

getQueue in interface QueueSender

Returns:

Queue queue

Throws:

IllegalStateException - If the publisher is m_closed.

JMSException

See Also:

QueueSender.getQueue()

send

public void send(Queue queue,
                 Message message)
          throws JMSException

API method. Sends a message to a queue for an unidentified message producer. Uses the QueueSender's default delivery mode, priority, and time to live.

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

Specified by:

send in interface QueueSender

Parameters:

queue - the queue to send this message to

message - the message to send

Throws:

JMSException - if the JMS provider fails to send the message due to some internal error.

MessageFormatException - if an invalid message is specified.

InvalidDestinationException - if a client uses this method with an invalid queue.

See Also:

MessageProducer.getDeliveryMode(), MessageProducer.getTimeToLive(), MessageProducer.getPriority(), QueueSender.send(javax.jms.Queue, javax.jms.Message)

send

public void send(Queue queue,
                 Message message,
                 int deliveryMode,
                 int priority,
                 long timeToLive)
          throws JMSException

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

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

Specified by:

send in interface QueueSender

Parameters:

queue - the queue to send this message to

message - the message to send

deliveryMode - the delivery mode to use

priority - the priority for this message

timeToLive - the message's lifetime (in milliseconds)

Throws:

JMSException - if the JMS provider fails to send the message due to some internal error.

MessageFormatException - if an invalid message is specified.

InvalidDestinationException - if a client uses this method with an invalid queue.

See Also:

QueueSender.send(javax.jms.Queue, javax.jms.Message, int, int, long)

send

public void send(Message message)
          throws JMSException

Sends a message to the queue. Uses the QueueSender's default delivery mode, priority, and time to live.

Specified by:

send in interface MessageProducer

Specified by:

send in interface QueueSender

Overrides:

send in class GSMessageProducerImpl

Parameters:

message - the message to send

Throws:

JMSException - if the JMS provider fails to send the message due to some internal error.

MessageFormatException - if an invalid message is specified.

InvalidDestinationException - if a client uses this method with a QueueSender with an invalid queue.

UnsupportedOperationException - if a client uses this method with a QueueSender that did not specify a queue at creation time.

See Also:

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

close

public void close()
           throws JMSException

Close the sender

Specified by:

close in interface MessageProducer

Overrides:

close in class GSMessageProducerImpl

Throws:

JMSException - if the sender can't be m_closed

See Also:

MessageProducer.close()