com.ibm.websphere.sib.api.jms

Interface JmsMsgProducer

All Superinterfaces:

javax.jms.MessageProducer

public interface JmsMsgProducer
extends javax.jms.MessageProducer

Contains provider specific methods relating to the javax.jms.MessageProducer interface.

Methods for which the security implications are not explicitly documented do not have any security considerations, do not check security permissions and do not affect any secured resources.

Method Summary

Methods

Modifier and Type	Method and Description
void	send(javax.jms.Destination destination, javax.jms.Message message, int deliveryMode, int priority, long timeToLive) Send a message to the specified destination.
void	send(javax.jms.Message message, int deliveryMode, int priority, long timeToLive) Send a message to the Destination that was specified when the message producer was created.
void	setTimeToLive(long timeToLive) Set a default timeToLive for messages sent using this message producer.

Methods inherited from interface javax.jms.MessageProducer

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

Method Detail

setTimeToLive

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

Set a default timeToLive for messages sent using this message producer.

Specified by:

setTimeToLive in interface javax.jms.MessageProducer

Parameters:

timeToLive - the default timeToLive value in ms to be used in the send methods which don't provide a more specific value as a parameter. Must be in the range 0 to ApiJmsConstants.MAX_TIME_TO_LIVE inclusive. 0 is interpreted as unlimited.

Throws:

javax.jms.JMSException - if the supplied value is out of range

See Also:

ApiJmsConstants.MAX_TIME_TO_LIVE, MessageProducer.setTimeToLive(long)

send

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

Send a message to the Destination that was specified when the message producer was created.

A JMSSecurityException will be thrown if the user ID is not in the sender role for the destination.

Specified by:

send in interface javax.jms.MessageProducer

Parameters:

message - the Message to be sent

deliveryMode - one of DeliveryMode.PERSISTENT or DeliveryMode.NON_PERSISTENT. These will be mapped to a quality of service using the settings in the connection factory from which the MessageProducer was derived.

priority - the priority with which to send the message, in the range 0 through 9

timeToLive - the length of time in milliseconds before the message should be expired. Must be in the range 0 to ApiJmsConstants.MAX_TIME_TO_LIVE inclusive. 0 is interpreted as unlimited.

Throws:

javax.jms.JMSSecurityException - with linked SINotAuthorizedException if the userID is not in the sender role for the destination.

javax.jms.JMSException - if the provider is unable to send the message

See Also:

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

send

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

Send a message to the specified destination.

A JMSSecurityException will be thrown if the user ID is not in the sender role for the destination.

Specified by:

send in interface javax.jms.MessageProducer

Parameters:

destination - the Destination the message should be sent to.

message - the Message to be sent

deliveryMode - one of DeliveryMode.PERSISTENT or DeliveryMode.NON_PERSISTENT. These will be mapped to a quality of service using the settings in the connection factory from which the MessageProducer was derived.

priority - the priority with which to send the message, in the range 0 through 9

timeToLive - the length of time in milliseconds before the message should be expired. Must be in the range 0 to ApiJmsConstants.MAX_TIME_TO_LIVE inclusive. 0 is interpreted as unlimited.

Throws:

javax.jms.JMSSecurityException - with linked SINotAuthorizedException if the userID is not in the sender role for the destination.

javax.jms.JMSException - if the provider is unable to send the message

See Also:

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