com.solacesystems.jms

Class SolMessageProducer

java.lang.Object

com.solacesystems.jms.SolMessageProducer

All Implemented Interfaces:

SolCloseableIF, SolMessageProducerIF, SolProducerEventSource, MessageProducer

Direct Known Subclasses:

SolQueueSender, SolTopicPublisher

public class SolMessageProducer
extends Object
implements SolMessageProducerIF, SolProducerEventSource

Field Summary

Fields

Modifier and Type	Field and Description
static JMSEncoder	Encoder

Method Summary

Modifier and Type	Method and Description
void	cancel(JCSMPException e)
void	close() Closes the message producer.
boolean	deliverToOne()
int	getDeliveryMode() Gets the producer's default delivery mode.
Destination	getDestination() Gets the destination associated with this MessageProducer.
boolean	getDisableMessageID() Gets an indication of whether message IDs are disabled.
boolean	getDisableMessageTimestamp() Gets an indication of whether message timestamps are disabled.
int	getPriority() Gets the producer's default priority.
long	getTimeToLive() Gets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.
boolean	isDMQEligible()
boolean	isElidingEligible()
boolean	isReplyMessage()
boolean	isXMLPayload()
void	send(Destination destination, Message message) Sends a message to a destination for an unidentified message producer.
void	send(Destination destination, Message message, int deliveryMode, int priority, long timeToLive) Sends a message to a destination for an unidentified message producer, specifying delivery mode, priority and time to live.
void	send(Message message) Sends a message using the MessageProducer's default delivery mode, priority, and time to live.
void	send(Message message, int deliveryMode, int priority, long timeToLive) Sends a message to the destination, specifying delivery mode, priority, and time to live.
void	setDeliveryMode(int deliveryMode) Sets the producer's default delivery mode.
void	setDisableMessageID(boolean value) Sets whether message IDs are disabled.
void	setDisableMessageTimestamp(boolean value) Sets whether message timestamps are disabled.
void	setPriority(int defaultPriority) Sets the producer's default priority.
void	setProducerEventListener(SolProducerEventListener eventHandler) Called to set the SolProducerEventListener on a MessageProducer.
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.
boolean	useDirectMessaging()

Methods inherited from class java.lang.Object

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

Field Detail

Encoder

public static JMSEncoder Encoder

Method Detail

close

public void close()
           throws JMSException

Description copied from interface: MessageProducer

Closes the message producer.

Since a provider may allocate some resources on behalf of a MessageProducer outside the Java virtual machine, clients should close them when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

Specified by:

close in interface SolCloseableIF

Specified by:

close in interface MessageProducer

Throws:

JMSException - if the JMS provider fails to close the producer due to some internal error.

cancel

public void cancel(JCSMPException e)

Specified by:

cancel in interface SolMessageProducerIF

setProducerEventListener

public void setProducerEventListener(SolProducerEventListener eventHandler)

Description copied from interface: SolProducerEventSource

Called to set the SolProducerEventListener on a MessageProducer. It can be reset by using a null argument.

Specified by:

setProducerEventListener in interface SolProducerEventSource

Parameters:

eventHandler - The listener to set; null to clear the listener.

getDeliveryMode

public int getDeliveryMode()
                    throws JMSException

Description copied from interface: MessageProducer

Gets the producer's default delivery mode.

Specified by:

getDeliveryMode in interface MessageProducer

Returns:

the message delivery mode for this message producer

Throws:

JMSException - if the JMS provider fails to get the delivery mode due to some internal error.

See Also:

MessageProducer.setDeliveryMode(int)

getDestination

public Destination getDestination()
                           throws JMSException

Description copied from interface: MessageProducer

Gets the destination associated with this MessageProducer.

Specified by:

getDestination in interface MessageProducer

Returns:

this producer's Destination

Throws:

JMSException - if the JMS provider fails to get the destination for this MessageProducer due to some internal error.

getDisableMessageID

public boolean getDisableMessageID()
                            throws JMSException

Description copied from interface: MessageProducer

Gets an indication of whether message IDs are disabled.

Specified by:

getDisableMessageID in interface MessageProducer

Returns:

an indication of whether message IDs are disabled

Throws:

JMSException - if the JMS provider fails to determine if message IDs are disabled due to some internal error.

getDisableMessageTimestamp

public boolean getDisableMessageTimestamp()
                                   throws JMSException

Description copied from interface: MessageProducer

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:

JMSException - if the JMS provider fails to determine if timestamps are disabled due to some internal error.

getPriority

public int getPriority()
                throws JMSException

Description copied from interface: MessageProducer

Gets the producer's default priority.

Specified by:

getPriority in interface MessageProducer

Returns:

the message priority for this message producer

Throws:

JMSException - if the JMS provider fails to get the priority due to some internal error.

See Also:

MessageProducer.setPriority(int)

getTimeToLive

public long getTimeToLive()
                   throws JMSException

Description copied from interface: MessageProducer

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

Specified by:

getTimeToLive in interface MessageProducer

Returns:

the message time to live in milliseconds; zero is unlimited

Throws:

JMSException - if the JMS provider fails to get the time to live due to some internal error.

See Also:

MessageProducer.setTimeToLive(long)

send

public void send(Message message)
          throws JMSException

Description copied from interface: MessageProducer

Sends a message using the MessageProducer's default delivery mode, priority, and time to live.

When sending non-persistent messages, notifications of quota, permission, or endpoint problems will occur by sending an exception asynchronously through the Connection's ExceptionListener. In this case the send API will return without error but the message will not have been accepted. When sending persistent messages, the send API will always throw an exception when messages are not accepted.

Specified by:

send in interface MessageProducer

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 MessageProducer with an invalid destination.

See Also:

Session.createProducer(javax.jms.Destination), MessageProducer

send

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

Description copied from interface: MessageProducer

Sends a message to the destination, specifying delivery mode, priority, and time to live.

When sending non-persistent messages, notifications of quota, permission, or endpoint problems will occur by sending an exception asynchronously through the Connection's ExceptionListener. In this case the send API will return without error but the message will not have been accepted. When sending persistent messages, the send API will always throw an exception when messages are not accepted.

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) Supported since 4.6.1 SolOS-TR.

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 MessageProducer with an invalid destination.

See Also:

Session.createProducer(javax.jms.Destination)

send

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

Description copied from interface: MessageProducer

Sends a message to a destination for an unidentified message producer. Uses the MessageProducer's default delivery mode, priority, and time to live.

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.

When sending non-persistent messages, notifications of quota, permission, or endpoint problems will occur by sending an exception asynchronously through the Connection's ExceptionListener. In this case the send API will return without error but the message will not have been accepted. When sending persistent messages, the send API will always throw an exception when messages are not accepted.

Specified by:

send in interface MessageProducer

Parameters:

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

See Also:

Session.createProducer(javax.jms.Destination), MessageProducer

send

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

Description copied from interface: MessageProducer

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

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.

When sending non-persistent messages, notifications of quota, permission, or endpoint problems will occur by sending an exception asynchronously through the Connection's ExceptionListener. In this case the send API will return without error but the message will not have been accepted. When sending persistent messages, the send API will always throw an exception when messages are not accepted.

Specified by:

send in interface MessageProducer

Parameters:

destination - 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) Supported since 4.6.1 SolOS-TR.

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

See Also:

Session.createProducer(javax.jms.Destination)

setDeliveryMode

public void setDeliveryMode(int deliveryMode)
                     throws JMSException

Description copied from interface: MessageProducer

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:

JMSException - if the JMS provider fails to set the delivery mode due to some internal error.

See Also:

MessageProducer.getDeliveryMode(), DeliveryMode.NON_PERSISTENT, DeliveryMode.PERSISTENT, Message.DEFAULT_DELIVERY_MODE

setDisableMessageID

public void setDisableMessageID(boolean value)
                         throws JMSException

Description copied from interface: MessageProducer

Sets whether message IDs are disabled.

Since message IDs take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the message ID is not used by an application. By calling the setDisableMessageID method on this message producer, a JMS client enables this potential optimization for all messages sent by this message producer. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value.

Message IDs are enabled by default.

Specified by:

setDisableMessageID in interface MessageProducer

Parameters:

value - indicates if message IDs are disabled

Throws:

JMSException - if the JMS provider fails to set message ID to disabled due to some internal error.

setDisableMessageTimestamp

public void setDisableMessageTimestamp(boolean value)
                                throws JMSException

Description copied from interface: MessageProducer

Sets whether message timestamps are disabled.

Since timestamps take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are 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. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint, the timestamp must be set to its normal value.

Message timestamps are enabled by default.

Specified by:

setDisableMessageTimestamp in interface MessageProducer

Parameters:

value - indicates if message timestamps are disabled

Throws:

JMSException - if the JMS provider fails to set timestamps to disabled due to some internal error.

setPriority

public void setPriority(int defaultPriority)
                 throws JMSException

Description copied from interface: MessageProducer

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.

Specified by:

setPriority in interface MessageProducer

Parameters:

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

Throws:

JMSException - if the JMS provider fails to set the priority due to some internal error.

See Also:

MessageProducer.getPriority(), Message.DEFAULT_PRIORITY

setTimeToLive

public void setTimeToLive(long timeToLive)
                   throws JMSException

Description copied from interface: MessageProducer

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 MessageProducer

Parameters:

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

Throws:

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

deliverToOne

public boolean deliverToOne()

Specified by:

deliverToOne in interface SolMessageProducerIF

isDMQEligible

public boolean isDMQEligible()

Specified by:

isDMQEligible in interface SolMessageProducerIF

isElidingEligible

public boolean isElidingEligible()

Specified by:

isElidingEligible in interface SolMessageProducerIF

isXMLPayload

public boolean isXMLPayload()

Specified by:

isXMLPayload in interface SolMessageProducerIF

useDirectMessaging

public boolean useDirectMessaging()

Specified by:

useDirectMessaging in interface SolMessageProducerIF

isReplyMessage

public boolean isReplyMessage()

Specified by:

isReplyMessage in interface SolMessageProducerIF