|
Oracle | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WLMessageProducer
A WLMessageProducer provides methods not supported by javax.jms.MessageProducer.
WLMessageProducer provide methods for the following:
MessageProducer
Method Summary | |
---|---|
void |
forward(Destination destination,
Message message)
Forwards a message to a destination for an unidentified message producer. |
void |
forward(Destination destination,
Message message,
int deliveryMode,
int priority,
long timeToLive)
Forwards a message to a destination for an unidentified message producer, specifying delivery mode, priority and time-to-live. |
void |
forward(Message message)
Forwards a message using the MessageProducer's default delivery mode, priority, and time to live. |
void |
forward(Message message,
int deliveryMode,
int priority,
long timeToLive)
Forwards a message to a destination, specifying delivery mode, priority, and time-to-live. |
int |
getCompressionThreshold()
The number of bytes for the serialized message body so any message that exceeds this limit will trigger message compression when the message is sent by the JMS message producer. |
int |
getRedeliveryLimit()
Get the redelivery limit for the producer. |
long |
getSendTimeout()
Get the send timeout for the producer. |
long |
getTimeToDeliver()
Get the time-to-deliver for this producer. |
String |
getUnitOfOrder()
Get the Unit-of-Order name associated with the producer. |
void |
setCompressionThreshold(int limit)
The number of bytes for the serialized message body so any message that exceeds this limit will trigger message compression when the message is sent by the JMS message producer. |
void |
setRedeliveryLimit(int redeliveryLimit)
Set the redelivery limit for the producer. |
void |
setSendTimeout(long sendTimeout)
Set the send timeout for the producer. |
void |
setTimeToDeliver(long timeToDeliver)
Set the time-to-deliver for this producer. |
void |
setUnitOfOrder()
Set the Unit-of-Order for this producer with a system-generated name. |
void |
setUnitOfOrder(String name)
Set the Unit-of-Order name for this producer. |
Method Detail |
---|
long getTimeToDeliver() throws JMSException
javax.jms.JMSException
- if a JMS error occurs.
JMSException
WLMessageProducer.setTimeToDeliver(long)
,
WLMessage.getJMSDeliveryTime()
void setTimeToDeliver(long timeToDeliver) throws JMSException
timeToDeliver
- The time to deliver this message.
javax.jms.JMSException
- if a JMS error occurs.
JMSException
WLMessageProducer.getTimeToDeliver()
,
WLMessage.getJMSDeliveryTime()
int getRedeliveryLimit() throws JMSException
javax.jms.JMSException
- if a JMS error occurs.
JMSException
WLMessage.getJMSRedeliveryLimit()
,
WLMessage.setJMSRedeliveryLimit(int)
void setRedeliveryLimit(int redeliveryLimit) throws JMSException
redeliveryLimit
- the number of times to redeliver the message
javax.jms.JMSException
- if a JMS error occurs.
JMSException
WLMessage.getJMSRedeliveryLimit()
,
WLMessage.setJMSRedeliveryLimit(int)
long getSendTimeout() throws JMSException
javax.jms.JMSException
- if a JMS error occurs.
JMSException
void setSendTimeout(long sendTimeout) throws JMSException
the
- send timeout in milliseconds
javax.jms.JMSException
- if a JMS error occurs.
JMSException
String getUnitOfOrder() throws JMSException
javax.jms.JMSException
- if a JMS error occurs.
JMSException
void setUnitOfOrder(String name) throws JMSException
the
- name or null if none is to be used.
javax.jms.JMSException
- if a JMS error occurs.
UnsupportedOperationException
- if the frontend is older
than 9.0 (diablo)
JMSException
void setUnitOfOrder() throws JMSException
javax.jms.JMSException
- if a JMS error occurs.
UnsupportedOperationException
- if the frontend is older
than 9.0 (diablo)
JMSException
void forward(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
send
verb on the WLMessageProducer, as follows:
send(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException;
Note: Forwarding a newly created message causes a JMSClientException. The forward() method can only be used on unmodified received messages.
message
- - the message to forwarddeliveryMode
- - the delivery mode to usepriority
- - the priority for this messagetimeToLive
- - the message's lifetime (in milliseconds)
JMSException
- - if the JMS provider fails to forward the message
due to some internal error or the message is not forwardable.
MessageFormatException
- - if an invalid message is specified.
InvalidDestinationException
- - if a client uses this method with a
MessageProducer with an invalid destination.
UnsupportedOperationException
- - if a client uses this method with a
MessageProducer that did not specify a destination at creation time.void forward(Message message) throws JMSException
send
verb on the WLMessageProducer, as follows:
send(Message message) throws JMSException;
Note: Forwarding a newly created message causes a JMSClientException. The forward() method can only be used on unmodified received messages.
message
- - the message to forward
JMSException
- - if the JMS provider fails to send the message
due to some internal error or the message is not forwardable.
MessageFormatException
- - if an invalid message is specified.
InvalidDestinationException
- - if a client uses this method with a
MessageProducer with an invalid destination.
UnsupportedOperationException
- - if a client uses this method with a
MessageProducer that did not specify a destination at creation time.void forward(Destination destination, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
send
verb on the WLMessageProducer, as follows:
send(Destination destination, Message message, int deliveryMode, int priority,
long timeToLive) throws JMSException;
Note: Forwarding a newly created message causes a JMSClientException. The forward() method can only be used on unmodified received messages.
destination
- - the destination to forward this message tomessage
- - the message to forwarddeliveryMode
- - the delivery mode to usepriority
- - the priority for this messagetimeToLive
- -the message's lifetime (in milliseconds)
JMSException
- - if the JMS provider fails to forward the message
due to some internal error or the message is not forwardable.
MessageFormatException
- - if an invalid message is specified.
InvalidDestinationException
- - if a client uses this method with a
MessageProducer with an invalid destination.
UnsupportedOperationException
- - if a client uses this method with a
MessageProducer that did specify a destination at creation time.void forward(Destination destination, Message message) throws JMSException
send
verb on the WLMessageProducer, as follows:
send(Destination destination, Message message) throws JMSException;
Note: Forwarding a newly created message causes a JMSClientException. The forward() method can only be used on unmodified received messages.
destination
- - the destination to forward this message tomessage
- - the message to forward
JMSException
- - if the JMS provider fails to forward the message
due to some internal error or the message is not forwardable.
MessageFormatException
- - if an invalid message is specified.
InvalidDestinationException
- - if a client uses this method with a
MessageProducer with an invalid destination.
UnsupportedOperationException
- - if a client uses this method with a
MessageProducer that did specify a destination at creation time.void setCompressionThreshold(int limit) throws JMSException
The number of bytes for the serialized message body so any message that exceeds this limit will trigger message compression when the message is sent by the JMS message producer.
The compression occurs on the JMS message producer's JVM if the JMS message producer's JVM is not collocated with the JMS provider's JVM and if the message body size exceeds the threshold limit.
The compression threshold value can be set to zero or higher. Setting it to zero will cause every message body to be compressed, except when messages are sent to a prior WebLogic Server release that doesn't support this feature.
limit
- - minimum of the serialized message body size to trigger the
compression.
JMSException
int getCompressionThreshold() throws JMSException
The number of bytes for the serialized message body so any message that exceeds this limit will trigger message compression when the message is sent by the JMS message producer.
The compression occurs on the JMS message producer's JVM if the JMS message producer's JVM is not collocated with the JMS provider's JVM and if the message body size exceeds the threshold limit.
The compression threshold value can be set to zero or higher. Setting it to zero will cause every message body to be compressed, except when messages are sent to a prior WebLogic Server release that doesn't support this feature.
JMSException
|
Documentation is available at http://edocs.bea.com/wls/docs103 Copyright 1996,2008, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |