org.exolab.jms.client
Class JmsMessageProducer

java.lang.Object
  |
  +--org.exolab.jms.client.JmsMessageProducer

All Implemented Interfaces:

javax.jms.MessageProducer

Direct Known Subclasses:

JmsQueueSender, JmsTopicPublisher

public abstract class JmsMessageProducer

extends java.lang.Object

implements javax.jms.MessageProducer

A client uses this class to deliver messages to a destination. This base class defines some methods which can be used to hold some default values including default time to live and default priority. A MessageProducer must always be created with a non-null session and destination. The session identifies the controlling entity.

Version:

$Revision: 1.18 $ $Date: 2004/01/02 04:33:23 $

Author:

Jim Alateras

Field Summary

protected org.exolab.jms.client.JmsSession

_session This is the session_ that created this producer.

Constructor Summary

JmsMessageProducer(org.exolab.jms.client.JmsSession session)
Construct a new JmsMessageProducer

Method Summary

void	close()
void	destroy() Release all resources used by this consumer
int	getDeliveryMode()
boolean	getDisableMessageID()
boolean	getDisableMessageTimestamp()
int	getPriority()
long	getTimeToLive()
boolean	isClosed() Determines if the producer is closed
protected void	sendMessage(javax.jms.Destination destination, javax.jms.Message message, int deliveryMode, int priority, long timeToLive) Send a message.
void	setDeliveryMode(int deliveryMode)
void	setDisableMessageID(boolean value)
void	setDisableMessageTimestamp(boolean value)
void	setPriority(int defaultPriority)
void	setTimeToLive(long timeToLive)

Methods inherited from class java.lang.Object

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

Field Detail

_session

protected org.exolab.jms.client.JmsSession _session

This is the session_ that created this producer.

Constructor Detail

JmsMessageProducer

public JmsMessageProducer(org.exolab.jms.client.JmsSession session)

Construct a new JmsMessageProducer

Parameters:

session - session responsible for this producer

Method Detail

setDisableMessageID

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

Specified by:

setDisableMessageID in interface javax.jms.MessageProducer

getDisableMessageID

public boolean getDisableMessageID()
                            throws javax.jms.JMSException

Specified by:

getDisableMessageID in interface javax.jms.MessageProducer

setDisableMessageTimestamp

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

Specified by:

setDisableMessageTimestamp in interface javax.jms.MessageProducer

getDisableMessageTimestamp

public boolean getDisableMessageTimestamp()
                                   throws javax.jms.JMSException

Specified by:

getDisableMessageTimestamp in interface javax.jms.MessageProducer

setDeliveryMode

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

Specified by:

setDeliveryMode in interface javax.jms.MessageProducer

getDeliveryMode

public int getDeliveryMode()
                    throws javax.jms.JMSException

Specified by:

getDeliveryMode in interface javax.jms.MessageProducer

setPriority

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

Specified by:

setPriority in interface javax.jms.MessageProducer

getPriority

public int getPriority()
                throws javax.jms.JMSException

Specified by:

getPriority in interface javax.jms.MessageProducer

setTimeToLive

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

Specified by:

setTimeToLive in interface javax.jms.MessageProducer

getTimeToLive

public long getTimeToLive()
                   throws javax.jms.JMSException

Specified by:

getTimeToLive in interface javax.jms.MessageProducer

close

public void close()
           throws javax.jms.JMSException

Specified by:

close in interface javax.jms.MessageProducer

destroy

public void destroy()
             throws javax.jms.JMSException

Release all resources used by this consumer

Throws:

javax.jms.JMSException -

isClosed

public boolean isClosed()

Determines if the producer is closed

Returns:

true if the producer is closed

sendMessage

protected void sendMessage(javax.jms.Destination destination,
                           javax.jms.Message message,
                           int deliveryMode,
                           int priority,
                           long timeToLive)
                    throws javax.jms.JMSException

Send a message.

Parameters:

destination - the destination to send to

message - the message to send

deliveryMode - the delivery mode to use

priority - the priority for the message

timeToLive - the message's lifetime, in milliseconds

Throws:

javax.jms.JMSException - if the message cannot be sent