Package weblogic.jms.extensions

Interface WLMessage

All Superinterfaces:

javax.jms.Message, WLAcknowledgeInfo

public interface WLMessage
extends WLAcknowledgeInfo

A WLMessage provides methods not supported by javax.jms.Message.

WLMessage provide methods for the following:

• Setting the delivery time for the message
• Getting the delivery time for the message

See Also:

Message

Method Summary

Modifier and Type	Method	Description
boolean	getDDForwarded()	Return true if the message is forwarded from one DD Member to another or from SAFImported Destination to a DD Member
long	getJMSDeliveryTime()	Deprecated. As of 9.0, replaced by javax.jms.Message.getIntProperty("JMS_BEA_DeliveryTime").
org.w3c.dom.Document	getJMSMessageDocument()	Returns an XML DOM Document representation of the message.
int	getJMSRedeliveryLimit()	Deprecated. As of 9.0, replaced by javax.jms.Message.getIntProperty("JMS_BEA_RedeliveryLimit").
java.lang.String	getUnitOfOrder()	Get Unit-of-Order name.
void	setJMSDeliveryTime(long deliveryTime)	Deprecated. As of 9.0, no longer needed.
void	setJMSRedeliveryLimit(int redeliveryLimit)	Deprecated. As of 9.0, no longer needed.

Method Detail

getJMSDeliveryTime

@Deprecated
long getJMSDeliveryTime()
                 throws javax.jms.JMSException

Deprecated.

As of 9.0, replaced by javax.jms.Message.getIntProperty("JMS_BEA_DeliveryTime").

Get the delivery time for the message; the delivery time is an absolute time expressed in milliseconds. This value is set by the provider when the message sent.

Specified by:

getJMSDeliveryTime in interface javax.jms.Message

Returns:

The delivery time for the message.

Throws:

javax.jms.JMSException - if a JMS error occurs.

See Also:

WLMessageProducer.getTimeToDeliver(), WLMessageProducer.setTimeToDeliver(long)

setJMSDeliveryTime

@Deprecated
void setJMSDeliveryTime(long deliveryTime)
                 throws javax.jms.JMSException

Deprecated.

As of 9.0, no longer needed.

Set the delivery time for the message; this method is for use by providers only, and is called automatically when a message is sent. When the message is sent, the current redelivery time is over-ridden.

Specified by:

setJMSDeliveryTime in interface javax.jms.Message

Parameters:

deliveryTime - the time to deliver this message.

Throws:

javax.jms.JMSException - if a JMS error occurs.

See Also:

WLMessageProducer.getTimeToDeliver(), WLMessageProducer.setTimeToDeliver(long)

getJMSRedeliveryLimit

@Deprecated
int getJMSRedeliveryLimit()
                   throws javax.jms.JMSException

Deprecated.

As of 9.0, replaced by javax.jms.Message.getIntProperty("JMS_BEA_RedeliveryLimit").

Get the redelivery limit for the message. This is the number of times a message will be redelivered after a recover or rollback. This method should only be called by JMS providers. The value is set by the producer when the message is sent.

Returns:

The number of times to redeliver the message

Throws:

javax.jms.JMSException - if a JMS error occurs.

See Also:

WLMessageProducer.getRedeliveryLimit(), WLMessageProducer.setRedeliveryLimit(int)

setJMSRedeliveryLimit

@Deprecated
void setJMSRedeliveryLimit(int redeliveryLimit)
                    throws javax.jms.JMSException

Deprecated.

As of 9.0, no longer needed.

Set the redelivery limit for the message. This is the number of times a message will be redelivered after a recover or rollback. This method should only be called by JMS providers. The value is set by the producer when the message is sent.

Parameters:

redeliveryLimit - the number of times to redeliver the message

Throws:

javax.jms.JMSException - if a JMS error occurs.

See Also:

WLMessageProducer.getRedeliveryLimit(), WLMessageProducer.setRedeliveryLimit(int)

getJMSMessageDocument

org.w3c.dom.Document getJMSMessageDocument()
                                    throws javax.jms.JMSException

Returns an XML DOM Document representation of the message.

Throws:

javax.jms.JMSException

getDDForwarded

boolean getDDForwarded()

Return true if the message is forwarded from one DD Member to another or from SAFImported Destination to a DD Member

Returns:

true if the message is forwarded from one DD Member to another or from SAFImported Destination to a DD Member

getUnitOfOrder

java.lang.String getUnitOfOrder()

Get Unit-of-Order name.

Returns:

unitOfOrderName