|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
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 | |
---|---|
abstract void |
forward(Destination destination, Message message) Forwards a message to a destination for an unidentified message producer. |
abstract 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. |
abstract void |
forward(Message message) Forwards a message using the MessageProducer's default delivery mode, priority, and time to live. |
abstract void |
forward(Message message, int deliveryMode, int priority, long timeToLive) Forwards a message to a destination, specifying delivery mode, priority, and time-to-live. |
abstract 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. |
abstract int |
getRedeliveryLimit() Get the redelivery limit for the producer. |
abstract long |
getSendTimeout() Get the send timeout for the producer. |
abstract long |
getTimeToDeliver() Get the time-to-deliver for this producer. |
abstract String |
getUnitOfOrder() Get the Unit-of-Order name associated with the producer. |
abstract 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. |
abstract void |
setRedeliveryLimit(int redeliveryLimit) Set the redelivery limit for the producer. |
abstract void |
setSendTimeout(long sendTimeout) Set the send timeout for the producer. |
abstract void |
setTimeToDeliver(long timeToDeliver) Set the time-to-deliver for this producer. |
abstract void |
setUnitOfOrder() Set the Unit-of-Order for this producer with a system-generated name. |
abstract void |
setUnitOfOrder(String name) Set the Unit-of-Order name for this producer. |
Methods inherited from interface javax.jms.MessageProducer |
---|
close, getDeliveryDelay, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, send, send, send, send, send, send, send, send, setDeliveryDelay, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive |
Method Detail |
---|
long getTimeToDeliver() throws JMSException
JMSException
- if a JMS error occurs.WLMessageProducer.setTimeToDeliver(long)
, WLMessage.getJMSDeliveryTime()
void setTimeToDeliver(long timeToDeliver) throws JMSException
timeToDeliver
- The time to deliver this message.JMSException
- if a JMS error occurs.WLMessageProducer.getTimeToDeliver()
, WLMessage.getJMSDeliveryTime()
int getRedeliveryLimit() throws JMSException
JMSException
- if a JMS error occurs.WLMessage.getJMSRedeliveryLimit()
, WLMessage.setJMSRedeliveryLimit(int)
void setRedeliveryLimit(int redeliveryLimit) throws JMSException
redeliveryLimit
- the number of times to redeliver the messageJMSException
- if a JMS error occurs.WLMessage.getJMSRedeliveryLimit()
, WLMessage.setJMSRedeliveryLimit(int)
long getSendTimeout() throws JMSException
JMSException
- if a JMS error occurs.void setSendTimeout(long sendTimeout) throws JMSException
sendTimeout
- the send timeout in millisecondsJMSException
- if a JMS error occurs.String getUnitOfOrder() throws JMSException
JMSException
- if a JMS error occurs.void setUnitOfOrder(String name) throws JMSException
name
- the name or null if none is to be used.JMSException
- if a JMS error occurs.UnsupportedOperationException
- if the frontend is older than 9.0 (diablo)void setUnitOfOrder() throws JMSException
JMSException
- if a JMS error occurs.UnsupportedOperationException
- if the frontend is older than 9.0 (diablo)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 forwardJMSException
- - 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 forwardJMSException
- - 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
|
Copyright 1996, 2015, 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. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |