com.j_spaces.jms

Class GSMessageProducerImpl

java.lang.Object

com.j_spaces.jms.GSMessageProducerImpl

All Implemented Interfaces:

javax.jms.MessageProducer, javax.jms.QueueSender, javax.jms.TopicPublisher

Direct Known Subclasses:

GSQueueSenderImpl, GSTopicPublisherImpl

public class GSMessageProducerImpl
extends Object
implements javax.jms.MessageProducer, javax.jms.QueueSender, javax.jms.TopicPublisher

GigaSpaces implementation of the javax.jms.MessageProducer interface. A client uses a MessageProducer object to send messages to a destination. A MessageProducer object is created by passing a Destination object to a message-producer creation method supplied by a m_session.

MessageProducer is the parent interface for all message producers.

A client also has the option of creating a message producer without supplying a destination. In this case, a destination must be provided with every send operation. A typical use for this kind of message producer is to send replies to requests using the request's JMSReplyTo destination.

A client can specify a default delivery mode, priority, and time to live for messages sent by a message producer. It can also specify the delivery mode, priority, and time to live for an individual message.

A client can specify a time-to-live value in milliseconds for each message it sends. This value defines a message expiration time that is the sum of the message's time-to-live and the GMT when it is sent (for transacted sends, this is the time the client sends the message, not the time the transaction is committed).

Version:

4.0 Copyright: Copyright (c) 2004 Company: GigaSpaces Technologies,Ltd.

Author:

Gershon Diner

See Also:

TopicPublisher, QueueSender, Session.createProducer(javax.jms.Destination)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_closed
protected javax.jms.Destination	m_dest The destination the producer belongs to
protected GSSessionImpl	m_session The session the producer belongs to

Constructor Summary

Constructors

Constructor and Description
GSMessageProducerImpl(GSSessionImpl sess, javax.jms.Destination m_dest, IMessageConverter messageConverter)

Method Summary

Modifier and Type	Method and Description
void	close() Cancels the AckDataEntry notify delegator, using its Lease.cancel() Also it removes the current producer from the producers list held by the m_session.
int	getDeliveryMode()
javax.jms.Destination	getDestination()
boolean	getDisableMessageID()
boolean	getDisableMessageTimestamp()
int	getPriority()
String	getProducerID()
javax.jms.Queue	getQueue()
protected GSSessionImpl	getSession() Returns the m_session that created this producer.
long	getTimeToLive()
javax.jms.Topic	getTopic()
void	publish(javax.jms.Message message)
void	publish(javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
void	publish(javax.jms.Topic topic, javax.jms.Message message)
void	publish(javax.jms.Topic topic, javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
void	send(javax.jms.Destination destination, javax.jms.Message message)
void	send(javax.jms.Destination _destination, javax.jms.Message _message, int _deliveryMode, int _priority, long _timeToLive) Sends a message with given delivery parameters for an unidentified message producer.
void	send(javax.jms.Message message)
void	send(javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
void	send(javax.jms.Queue queue, javax.jms.Message message)
void	send(javax.jms.Queue queue, javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
void	setDeliveryMode(int deliveryMode) Sets the messages DeliveryMode for all the messages which will be sent via this producer in the m_session level.
void	setDisableMessageID(boolean value)
void	setDisableMessageTimestamp(boolean value)
void	setPriority(int priority) Sets the priority for all the messages which be sent via this producer in the m_session level.
void	setProducerID(String m_producerID)
void	setTimeToLive(long timeToLive) Sets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_session

protected GSSessionImpl m_session

The session the producer belongs to

m_dest

protected javax.jms.Destination m_dest

The destination the producer belongs to

m_closed

protected volatile boolean m_closed

Constructor Detail

GSMessageProducerImpl

public GSMessageProducerImpl(GSSessionImpl sess,
                             javax.jms.Destination m_dest,
                             IMessageConverter messageConverter)
                      throws javax.jms.JMSException

Parameters:

sess - - The Session the producer belongs to

m_dest - - The destination (Queue or Topic) that the producer sends messages to

Throws:

javax.jms.JMSException

Method Detail

setDisableMessageID

public void setDisableMessageID(boolean value)
                         throws javax.jms.JMSException

Specified by:

setDisableMessageID in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.setDisableMessageID(boolean)

getDisableMessageID

public boolean getDisableMessageID()
                            throws javax.jms.JMSException

Specified by:

getDisableMessageID in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.getDisableMessageID()

setDisableMessageTimestamp

public void setDisableMessageTimestamp(boolean value)
                                throws javax.jms.JMSException

Specified by:

setDisableMessageTimestamp in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.setDisableMessageTimestamp(boolean)

setProducerID

public void setProducerID(String m_producerID)

getDisableMessageTimestamp

public boolean getDisableMessageTimestamp()
                                   throws javax.jms.JMSException

Specified by:

getDisableMessageTimestamp in interface javax.jms.MessageProducer

Returns:

m_timestampDisabled

Throws:

javax.jms.JMSException

See Also:

MessageProducer.getDisableMessageTimestamp()

setDeliveryMode

public void setDeliveryMode(int deliveryMode)
                     throws javax.jms.JMSException

Sets the messages DeliveryMode for all the messages which will be sent via this producer in the m_session level. available DeliveryModes are: DeliveryMode.PERSISTENT - the default and DeliveryMode.NON_PERSISTENT

Specified by:

setDeliveryMode in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.setDeliveryMode(int)

getDeliveryMode

public int getDeliveryMode()
                    throws javax.jms.JMSException

Specified by:

getDeliveryMode in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.getDeliveryMode()

setPriority

public void setPriority(int priority)
                 throws javax.jms.JMSException

Sets the priority for all the messages which be sent via this producer in the m_session level.

Specified by:

setPriority in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.setPriority(int)

getPriority

public int getPriority()
                throws javax.jms.JMSException

Specified by:

getPriority in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.getPriority()

setTimeToLive

public void setTimeToLive(long timeToLive)
                   throws javax.jms.JMSException

Sets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.

Time to live is set to zero by default.

Specified by:

setTimeToLive in interface javax.jms.MessageProducer

Parameters:

timeToLive - the message time to live in milliseconds; zero is unlimited, while then it is calculated according to the space ttl Lease.Forever which is Long.max_value

Throws:

javax.jms.JMSException - if the JMS provider fails to set the time to live due to some internal error.

See Also:

MessageProducer.getTimeToLive(), Message.DEFAULT_TIME_TO_LIVE

getTimeToLive

public long getTimeToLive()
                   throws javax.jms.JMSException

Specified by:

getTimeToLive in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.getTimeToLive()

getDestination

public javax.jms.Destination getDestination()
                                     throws javax.jms.JMSException

Specified by:

getDestination in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.getDestination()

close

public void close()
           throws javax.jms.JMSException

Cancels the AckDataEntry notify delegator, using its Lease.cancel() Also it removes the current producer from the producers list held by the m_session.

Specified by:

close in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.close()

send

public void send(javax.jms.Message message)
          throws javax.jms.JMSException

Specified by:

send in interface javax.jms.MessageProducer

Specified by:

send in interface javax.jms.QueueSender

Throws:

javax.jms.JMSException

See Also:

MessageProducer.send(Message)

send

public void send(javax.jms.Message message,
                 int deliveryMode,
                 int priority,
                 long timeToLive)
          throws javax.jms.JMSException

Specified by:

send in interface javax.jms.MessageProducer

Specified by:

send in interface javax.jms.QueueSender

Throws:

javax.jms.JMSException

See Also:

MessageProducer.send(Message, int, int, long)

send

public void send(javax.jms.Destination destination,
                 javax.jms.Message message)
          throws javax.jms.JMSException

Specified by:

send in interface javax.jms.MessageProducer

Throws:

javax.jms.JMSException

See Also:

MessageProducer.send(Destination, Message)

send

public void send(javax.jms.Destination _destination,
                 javax.jms.Message _message,
                 int _deliveryMode,
                 int _priority,
                 long _timeToLive)
          throws javax.jms.JMSException

Sends a message with given delivery parameters for an unidentified message producer.

Specified by:

send in interface javax.jms.MessageProducer

Throws:

UnsupportedOperationException - When the producer did not properly identify itself.

javax.jms.JMSSecurityException - If the user if not a WRITER on the specified destination.

javax.jms.IllegalStateException - If the producer is m_closed, or if the connection is broken.

javax.jms.JMSException - If the request fails for any other reason.

See Also:

MessageProducer.send(Destination, Message, int, int, long)

toString

public String toString()

Overrides:

toString in class Object

getProducerID

public String getProducerID()

Returns:

m_producerID

getSession

protected GSSessionImpl getSession()

Returns the m_session that created this producer. It might be a GSTopicSessionImpl or GSQueueSessionImpl

Returns:

the m_session that created this producer

getQueue

public javax.jms.Queue getQueue()
                         throws javax.jms.JMSException

Specified by:

getQueue in interface javax.jms.QueueSender

Throws:

javax.jms.JMSException

See Also:

QueueSender.getQueue()

send

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

Specified by:

send in interface javax.jms.QueueSender

Throws:

javax.jms.JMSException

See Also:

QueueSender.send(Queue, Message)

send

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

Specified by:

send in interface javax.jms.QueueSender

Throws:

javax.jms.JMSException

See Also:

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

getTopic

public javax.jms.Topic getTopic()
                         throws javax.jms.JMSException

Specified by:

getTopic in interface javax.jms.TopicPublisher

Throws:

javax.jms.JMSException

See Also:

TopicPublisher.getTopic()

publish

public void publish(javax.jms.Message message)
             throws javax.jms.JMSException

Specified by:

publish in interface javax.jms.TopicPublisher

Throws:

javax.jms.JMSException

See Also:

MessageProducer.send(Message)

publish

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

Specified by:

publish in interface javax.jms.TopicPublisher

Throws:

javax.jms.JMSException

See Also:

MessageProducer.send(Destination, Message)

publish

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

Specified by:

publish in interface javax.jms.TopicPublisher

Throws:

javax.jms.JMSException

See Also:

MessageProducer.send(Message, int, int, long)

publish

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

Specified by:

publish in interface javax.jms.TopicPublisher

Throws:

javax.jms.JMSException

See Also:

MessageProducer.send(Destination, Message, int, int, long)