Package org.objectweb.joram.client.jms

Class MessageProducer

java.lang.Object

org.objectweb.joram.client.jms.MessageProducer

All Implemented Interfaces:

AutoCloseable, MessageProducer

Direct Known Subclasses:

QueueSender, TopicPublisher

public class MessageProducer
extends Object
implements MessageProducer

Implements the javax.jms.MessageProducer interface.

A client uses a MessageProducer object to send messages to a destination. A MessageProducer object is created by calling the createProducer method on the session object. A message producer is normally dedicated to a unique destination.
A client also has the option of creating a message producer without supplying a unique destination. In this case, a destination must be provided with every send operation.
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 each individual message.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	closed	true if the producer is closed.
private long	deliveryDelay	Default delivery delay
private int	deliveryMode	Default delivery mode.
protected Destination	dest	The destination the producer sends messages to.
private boolean	identified	true if the producer's destination is identified.
private static org.objectweb.util.monolog.api.Logger	logger
private boolean	messageIDDisabled	true if the client requests not to use the message identifiers; however it is not taken into account, as our MOM needs message identifiers for managing acknowledgements.
private int	priority	Default priority.
protected Session	sess	The session the producer belongs to.
private boolean	timestampDisabled	true if the time stamp is disabled.
private long	timeToLive	Default time to live.

Constructor Summary

Constructors

Constructor	Description
MessageProducer(Session sess, Destination dest)	Constructs a producer.

Method Summary

Modifier and Type	Method	Description
void	close()	API method.
private void	doSend(Destination dest, Message message, int deliveryMode, int priority, long timeToLive)	Actually sends a message to a given destination.
private void	doSend(Destination dest, Message message, int deliveryMode, int priority, long timeToLive, CompletionListener completionListener)	Actually sends a message to a given destination.
long	getDeliveryDelay()	API 2.0 Get the delivery delay.
int	getDeliveryMode()	API method.
Destination	getDestination()	API method.
boolean	getDisableMessageID()	API method.
boolean	getDisableMessageTimestamp()	API method.
int	getPriority()	API method.
long	getTimeToLive()	API method.
void	send(Destination dest, Message message)	API method.
void	send(Destination dest, Message message, int deliveryMode, int priority, long timeToLive)	API method.
void	send(Destination destination, Message message, int deliveryMode, int priority, long timeToLive, CompletionListener completionListener)	API 2.0 method.
void	send(Destination destination, Message message, CompletionListener completionListener)	API 2.0 method.
void	send(Message message)	API method.
void	send(Message message, int deliveryMode, int priority, long timeToLive)	API method.
void	send(Message message, int deliveryMode, int priority, long timeToLive, CompletionListener completionListener)	API 2.0 method.
void	send(Message message, CompletionListener completionListener)	API 2.0 method.
void	setDeliveryDelay(long deliveryDelay)	API 2.0 Sets the minimum length of time in milliseconds that must elapse after a message is sent before the consumer can consume this message.
void	setDeliveryMode(int deliveryMode)	API method.
void	setDisableMessageID(boolean value)	API method, not taken into account.
void	setDisableMessageTimestamp(boolean value)	API method.
void	setPriority(int priority)	API method.
void	setTimeToLive(long timeToLive)	API method.

Methods inherited from class java.lang.Object

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

Field Detail

deliveryMode

private int deliveryMode

Default delivery mode.

priority

private int priority

Default priority.

timeToLive

private long timeToLive

Default time to live.

deliveryDelay

private long deliveryDelay

Default delivery delay

messageIDDisabled

private boolean messageIDDisabled

true if the client requests not to use the message identifiers; however it is not taken into account, as our MOM needs message identifiers for managing acknowledgements.

timestampDisabled

private boolean timestampDisabled

true if the time stamp is disabled.

identified

private boolean identified

true if the producer's destination is identified.

closed

protected boolean closed

true if the producer is closed.

sess

protected Session sess

The session the producer belongs to.

dest

protected Destination dest

The destination the producer sends messages to.

logger

private static org.objectweb.util.monolog.api.Logger logger

Constructor Detail

MessageProducer

MessageProducer(Session sess,
                Destination dest)
         throws JMSException

Constructs a producer.

Parameters:

sess - The session the producer belongs to.

dest - The destination the producer sends messages to.

Throws:

InvalidDestinationException - if an invalid destination is specified.

IllegalStateException - If the connection is broken.

JMSException - If the creation fails for any other reason.

Method Detail

setDisableMessageID

public void setDisableMessageID(boolean value)
                         throws JMSException

API method, not taken into account. Message IDs are always enabled.

Specified by:

setDisableMessageID in interface MessageProducer

Parameters:

value - indicates if message IDs are disabled, not taken in account.

Throws:

IllegalStateException - If the producer is closed.

JMSException

setDeliveryMode

public void setDeliveryMode(int deliveryMode)
                     throws JMSException

API method. Sets the producer's default delivery mode.

Delivery mode is set to PERSISTENT by default.

Specified by:

setDeliveryMode in interface MessageProducer

Parameters:

deliveryMode - the message delivery mode for this message producer; legal values are DeliveryMode.NON_PERSISTENT and DeliveryMode.PERSISTENT.

Throws:

IllegalStateException - If the producer is closed.

JMSException - When setting an invalid delivery mode.

setPriority

public void setPriority(int priority)
                 throws JMSException

API method. Sets the producer's default priority.

The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. Clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

Priority is set to 4 by default (Message.DEFAULT_PRIORITY).

Specified by:

setPriority in interface MessageProducer

Parameters:

priority - the message priority for this message producer; must be a value between 0 and 9.

Throws:

IllegalStateException - If the producer is closed.

JMSException - When setting an invalid priority.

setTimeToLive

public void setTimeToLive(long timeToLive)
                   throws JMSException

API method. Sets the default duration of time in milliseconds that a produced message should be retained by the provider.

Time to live is set to zero by default (Message.DEFAULT_TIME_TO_LIVE).

Specified by:

setTimeToLive in interface MessageProducer

Parameters:

timeToLive - the message time to live in milliseconds; zero is unlimited.

Throws:

IllegalStateException - If the producer is closed.

JMSException

setDisableMessageTimestamp

public void setDisableMessageTimestamp(boolean value)
                                throws JMSException

API method. Sets whether message timestamps are disabled.

Since timestamps take some effort to create and increase a message's size, Joram optimizes message overhead if it is given a hint that the timestamp is not used by an application. By calling the setDisableMessageTimestamp method on this message producer, a JMS client enables this potential optimization for all messages sent by this message producer (the produced messages have the timestamp set to zero).

Message timestamps are enabled by default.

Specified by:

setDisableMessageTimestamp in interface MessageProducer

Parameters:

value - indicates if message timestamps are disabled.

Throws:

IllegalStateException - If the producer is closed.

JMSException

getDestination

public Destination getDestination()
                           throws JMSException

API method. Gets the destination associated with this MessageProducer.

Specified by:

getDestination in interface MessageProducer

Returns:

the destination associated with this MessageProducer.

Throws:

IllegalStateException - If the producer is closed.

JMSException

getDisableMessageID

public boolean getDisableMessageID()
                            throws JMSException

API method. Gets an indication of whether message IDs are disabled, always false.

Specified by:

getDisableMessageID in interface MessageProducer

Returns:

false.

Throws:

IllegalStateException - If the producer is closed.

JMSException

getDeliveryMode

public int getDeliveryMode()
                    throws JMSException

API method. Gets the producer's default delivery mode, by default Message.DEFAULT_DELIVERY_MODE.

Specified by:

getDeliveryMode in interface MessageProducer

Returns:

the message delivery mode for this message producer.

Throws:

IllegalStateException - If the producer is closed.

JMSException

getPriority

public int getPriority()
                throws JMSException

API method. Gets the producer's default priority, by default Message.DEFAULT_PRIORITY.

Specified by:

getPriority in interface MessageProducer

Returns:

the message priority for this message producer.

Throws:

IllegalStateException - If the producer is closed.

JMSException

getTimeToLive

public long getTimeToLive()
                   throws JMSException

API method. Gets the default duration in milliseconds that a produced message should be retained by the provider, by default Message.DEFAULT_TIME_TO_LIVE.

Specified by:

getTimeToLive in interface MessageProducer

Returns:

the message time to live in milliseconds; zero is unlimited.

Throws:

IllegalStateException - If the producer is closed.

JMSException

getDisableMessageTimestamp

public boolean getDisableMessageTimestamp()
                                   throws JMSException

API method. Gets an indication of whether message timestamps are disabled.

Specified by:

getDisableMessageTimestamp in interface MessageProducer

Returns:

an indication of whether message timestamps are disabled.

Throws:

IllegalStateException - If the producer is closed.

JMSException

send

public void send(Message message)
          throws JMSException

API method. Sends a message with the MessageProducer's default delivery parameters.

Specified by:

send in interface MessageProducer

Parameters:

message - the message to send.

Throws:

UnsupportedOperationException - If the dest is unidentified.

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

JMSException - If the request fails for any other reason.

send

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

API method. Sends a message to the destination with given delivery parameters.

Specified by:

send in interface MessageProducer

Parameters:

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:

UnsupportedOperationException - If the dest is unidentified.

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

JMSException - If the request fails for any other reason.

send

public void send(Destination dest,
                 Message message)
          throws JMSException

API method. Sends a message to a destination for an unidentified message producer using default delivery parameters.

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

Specified by:

send in interface MessageProducer

Parameters:

dest - the destination to send this message to.

message - the message to send.

Throws:

UnsupportedOperationException - When the producer did not properly identify itself.

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

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

JMSException - If the request fails for any other reason.

send

public void send(Destination dest,
                 Message message,
                 int deliveryMode,
                 int priority,
                 long timeToLive)
          throws JMSException

API method. Sends a message to a destination for an unidentified message producer with given delivery parameters.

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

Specified by:

send in interface MessageProducer

Parameters:

dest - the destination 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:

UnsupportedOperationException - When the producer did not properly identify itself.

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

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

JMSException - If the request fails for any other reason.

send

public void send(Message message,
                 CompletionListener completionListener)
          throws JMSException

API 2.0 method. Sends asynchronous message with the MessageProducer's default delivery parameters.

Specified by:

send in interface MessageProducer

Parameters:

message - the message to send.

completionListener - the completion listener (call back).

Throws:

UnsupportedOperationException - If the dest is unidentified.

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

JMSException - If the request fails for any other reason.

send

public void send(Message message,
                 int deliveryMode,
                 int priority,
                 long timeToLive,
                 CompletionListener completionListener)
          throws JMSException

API 2.0 method. Sends asynchronous message to the destination with given delivery parameters.

Specified by:

send in interface MessageProducer

Parameters:

message - the message to send.

deliveryMode - the delivery mode to use.

priority - the priority for this message.

timeToLive - the message's lifetime in milliseconds.

completionListener - the completion listener (call back).

Throws:

UnsupportedOperationException - If the dest is unidentified.

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

JMSException - If the request fails for any other reason.

send

public void send(Destination destination,
                 Message message,
                 CompletionListener completionListener)
          throws JMSException

API 2.0 method. Sends asynchronous message to a destination for an unidentified message producer using default delivery parameters.

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

Specified by:

send in interface MessageProducer

Parameters:

dest - the destination to send this message to.

message - the message to send.

completionListener - the completion listener (call back).

Throws:

UnsupportedOperationException - When the producer did not properly identify itself.

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

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

JMSException - If the request fails for any other reason.

send

public void send(Destination destination,
                 Message message,
                 int deliveryMode,
                 int priority,
                 long timeToLive,
                 CompletionListener completionListener)
          throws JMSException

API 2.0 method. Sends asynchronous message to a destination for an unidentified message producer with given delivery parameters.

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

Specified by:

send in interface MessageProducer

Parameters:

dest - the destination 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.

completionListener - the completion listener (call back).

Throws:

UnsupportedOperationException - When the producer did not properly identify itself.

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

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

JMSException - If the request fails for any other reason.

close

public void close()
           throws JMSException

API method. Closes the message producer.

In order to free significant resources allocated on behalf of a MessageProducer, clients should close them when they are not needed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MessageProducer

Throws:

JMSException - Actually never thrown.

doSend

private void doSend(Destination dest,
                    Message message,
                    int deliveryMode,
                    int priority,
                    long timeToLive)
             throws JMSException

Actually sends a message to a given destination.

Throws:

MessageFormatException - If the message to send is invalid.

InvalidDestinationException - If the specified destination is invalid.

IllegalStateException - If the connection is broken.

JMSException - If the request fails for any other reason.

doSend

private void doSend(Destination dest,
                    Message message,
                    int deliveryMode,
                    int priority,
                    long timeToLive,
                    CompletionListener completionListener)
             throws JMSException

Actually sends a message to a given destination.

Throws:

MessageFormatException - If the message to send is invalid.

InvalidDestinationException - If the specified destination is invalid.

IllegalStateException - If the connection is broken.

JMSException - If the request fails for any other reason.

setDeliveryDelay

public void setDeliveryDelay(long deliveryDelay)
                      throws JMSException

API 2.0 Sets the minimum length of time in milliseconds that must elapse after a message is sent before the consumer can consume this message. the delivery delay is set to zero by default

Specified by:

setDeliveryDelay in interface MessageProducer

Parameters:

deliveryDelay - the delivery delay in milliseconds.

Throws:

JMSException

getDeliveryDelay

public long getDeliveryDelay()
                      throws JMSException

API 2.0 Get the delivery delay.

Specified by:

getDeliveryDelay in interface MessageProducer

Returns:

the delivery delay in milliseconds.

Throws:

JMSException