|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DefaultDeliveryParamsBean
If a client does not specify certain parameters then the values that those parameters will take can be controlled with a default delivery parameters bean.
Method Summary | |
---|---|
int |
getDefaultCompressionThreshold()
The number of bytes for the serialized message body so any message exceeds this limit will trigger message compression when the message is sent or received by the JMS message producer or consumer. |
String |
getDefaultDeliveryMode()
The default delivery mode used for messages when a delivery mode is not explicitly defined. |
int |
getDefaultPriority()
The default priority used for messages when a priority is not explicitly defined. |
long |
getDefaultRedeliveryDelay()
The delay time, in milliseconds, before rolled back or recovered messages are redelivered. |
String |
getDefaultTimeToDeliver()
The delay time, in milliseconds, between when a message is produced and when it is made visible on its destination. |
long |
getDefaultTimeToLive()
The maximum length of time, in milliseconds, that a message exists. |
String |
getDefaultUnitOfOrder()
The default Unit-of-Order name for producers that connect using this connection factory. |
long |
getSendTimeout()
The maximum length of time, in milliseconds, that a sender will wait when there isn't enough available space (no quota) on a destination to accommodate the message being sent. |
void |
setDefaultCompressionThreshold(int threshold)
Sets the value of the CompressionThreshold attribute. |
void |
setDefaultDeliveryMode(String defaultDeliveryMode)
Sets the value of the DefaultDeliveryMode attribute. |
void |
setDefaultPriority(int defaultPriority)
Sets the value of the DefaultPriority attribute. |
void |
setDefaultRedeliveryDelay(long defaultRedeliveryDelay)
Sets the value of the DefaultRedeliveryDelay attribute. |
void |
setDefaultTimeToDeliver(String defaultTimeToDeliver)
Sets the value of the DefaultTimeToDeliver attribute. |
void |
setDefaultTimeToLive(long defaultTimeToLive)
Sets the value of the DefaultTimeToLive attribute. |
void |
setDefaultUnitOfOrder(String defaultUnitOfOrder)
Sets the value of the DefaultUnitOfOrder attribute. |
void |
setSendTimeout(long sendTimeout)
Sets the value of the SendTimeout attribute. |
Methods inherited from interface weblogic.descriptor.SettableBean |
---|
isSet, unSet |
Method Detail |
---|
String getDefaultDeliveryMode()
The default delivery mode used for messages when a delivery mode is not explicitly defined.
All messages with a DefaultDeliveryMode of null
that are produced on a connection created with this
factory will receive this value. Message producers can get the delivery mode explicitly by calling the
javax.jms.MessageProducer.getDeliveryMode()
method.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
void setDefaultDeliveryMode(String defaultDeliveryMode) throws IllegalArgumentException
defaultDeliveryMode
- The new default delivery mode
IllegalArgumentException
DefaultDeliveryParamsBean.getDefaultDeliveryMode()
String getDefaultTimeToDeliver()
The delay time, in milliseconds, between when a message is produced and when it is made visible on its destination.
All messages produced by a producer created with this factory that have a DefaultTimeToDeliver of -1
will use this value. Message producers can get the Time-to-Deliver explicitly by calling the
weblogic.jms.extensions.WLMessageProducer.getTimeToDeliver()
method.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
void setDefaultTimeToDeliver(String defaultTimeToDeliver) throws IllegalArgumentException
Sets the value of the DefaultTimeToDeliver attribute.
defaultTimeToDeliver
- The new default time to deliver value
IllegalArgumentException
DefaultDeliveryParamsBean.getDefaultTimeToDeliver()
long getDefaultTimeToLive()
The maximum length of time, in milliseconds, that a message exists. This value is used for messages when both
the time-to-live
is not explicitly set by the sender application that is using this connection factory and
the time-to-live
is not explicitly overridden by the destination's TimeToLiveOverride
attribute .
A value of 0 indicates that the message has an infinite amount time to live.
Message producer applications can set the time-to-live
explicitly by calling the standard JMS
javax.jms.MessageProducer.setTimeToLive(long)
method. Note that programmatically setting
time-to-live
using javax.jms.Message.setJMSExpiration()
has no effect - the message
setter is ignored by the JMS send call as required by the JMS specification.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing
connections. It only affects new connections made with this connection factory.
- Returns:
- The defaultTimeToLive value
- Changes take effect after you redeploy the module or restart the server.
- Default Value:
- 0
setDefaultTimeToLive
void setDefaultTimeToLive(long defaultTimeToLive)
throws IllegalArgumentException
Sets the value of the DefaultTimeToLive attribute.
- Parameters:
defaultTimeToLive
- The new default time to live value
- Throws:
IllegalArgumentException
- See Also:
DefaultDeliveryParamsBean.getDefaultTimeToLive()
- Changes take effect after you redeploy the module or restart the server.
- Maximum Value:
- java.lang.Long.MAX_VALUE
- Minimum Value:
- 0
getDefaultPriority
int getDefaultPriority()
The default priority used for messages when a priority is not explicitly defined.
All messages with a DefaultPriority of -1 that are produced on a connection created with this
factory will receive this value. Message producers can get the priority explicitly by calling the
javax.jms.MessageProducer.getPriority()
method.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing
connections. It only affects new connections made with this connection factory.
- Returns:
- The defaultPriority value
- Changes take effect after you redeploy the module or restart the server.
- Default Value:
- weblogic.j2ee.descriptor.wl.constants.JMSConstants.PRIORITY_DEFAULT
setDefaultPriority
void setDefaultPriority(int defaultPriority)
throws IllegalArgumentException
Sets the value of the DefaultPriority attribute.
- Parameters:
defaultPriority
- The new default priority value
- Throws:
IllegalArgumentException
- See Also:
DefaultDeliveryParamsBean.getDefaultPriority()
- Changes take effect after you redeploy the module or restart the server.
- Maximum Value:
- weblogic.j2ee.descriptor.wl.constants.JMSConstants.PRIORITY_MAXIMUM
- Minimum Value:
- weblogic.j2ee.descriptor.wl.constants.JMSConstants.PRIORITY_MINIMUM
getDefaultRedeliveryDelay
long getDefaultRedeliveryDelay()
The delay time, in milliseconds, before rolled back or recovered messages are redelivered.
All messages consumed by a consumer created with this factory that have a DefaultRedeliveryDelay
of -1 will use this value.
Message consumers can get the redelivery delay explicitly by calling the
weblogic.jms.extensions.WLSession.getRedliveryDelay()
method.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing
connections. It only affects new connections made with this connection factory.
- Returns:
- The defaultRedeliveryDelay value
- Changes take effect after you redeploy the module or restart the server.
- Default Value:
- 0
setDefaultRedeliveryDelay
void setDefaultRedeliveryDelay(long defaultRedeliveryDelay)
throws IllegalArgumentException
- Sets the value of the DefaultRedeliveryDelay attribute.
- Parameters:
defaultRedeliveryDelay
- The new default redelivery delay
- Throws:
IllegalArgumentException
- See Also:
DefaultDeliveryParamsBean.getDefaultRedeliveryDelay()
- Changes take effect after you redeploy the module or restart the server.
- Maximum Value:
- java.lang.Long.MAX_VALUE
- Minimum Value:
- 0
getSendTimeout
long getSendTimeout()
The maximum length of time, in milliseconds, that a sender will wait when there isn't enough available space (no
quota) on a destination to accommodate the message being sent.
The default time is 10 milliseconds. A value of 0 indicates that the sender does not want to wait for space.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing
connections or their producers. It only affects new connections made with this connection factory. Producers
inherit the setting from the connection factory used to create their session and connection. The value can then be
overridden at run time by setting the value on the producer.
- Returns:
- The sendTimeout value
- Changes take effect after you redeploy the module or restart the server.
- Default Value:
- weblogic.j2ee.descriptor.wl.constants.JMSConstants.SEND_QUOTA_BLOCKING_TIMEOUT
setSendTimeout
void setSendTimeout(long sendTimeout)
throws IllegalArgumentException
Sets the value of the SendTimeout attribute.
- Parameters:
sendTimeout
- The send timeout value that a sender should wait in milliseconds
- Throws:
IllegalArgumentException
- See Also:
DefaultDeliveryParamsBean.getSendTimeout()
- Changes take effect after you redeploy the module or restart the server.
- Maximum Value:
- java.lang.Long.MAX_VALUE
- Minimum Value:
- 0
getDefaultCompressionThreshold
int getDefaultCompressionThreshold()
The number of bytes for the serialized message body so
any message exceeds this limit will trigger message compression when
the message is sent or received by the JMS message producer or consumer.
The compression will occur either:
-
On the JMS message producer's JVM if the JMS message producer's JVM is not collocated with the
JMS provider's JVM and the message body size exceeds the threshold limit.
-
On the JMS provider's JVM when the JMS message consumer's JVM is not collocated with the
JMS provider's JVM and the message body size exceeds the threshold limit.
- Returns:
- The compression threshold given to new connections
- Changes take effect after you redeploy the module or restart the server.
- Default Value:
- java.lang.Integer.MAX_VALUE
- Maximum Value:
- java.lang.Integer.MAX_VALUE
- Minimum Value:
- 0
setDefaultCompressionThreshold
void setDefaultCompressionThreshold(int threshold)
throws IllegalArgumentException
- Sets the value of the CompressionThreshold attribute.
- Parameters:
threshold
- The compression threshold new connections should use
- Throws:
IllegalArgumentException
- See Also:
DefaultDeliveryParamsBean.getDefaultCompressionThreshold()
- Changes take effect after you redeploy the module or restart the server.
getDefaultUnitOfOrder
String getDefaultUnitOfOrder()
The default Unit-of-Order name for producers that connect using this
connection factory. A Unit-of-Order allows for messages
to be processed in a certain order, even among multiple recipients.
System-generated
indicates that WebLogic Server will automatically generate
a Unit-of-Order name. User-Generated
indicates
that the Unit-of-Order name will come from the name specified name in the Unit-of-Order Name
field.
If None
is selected, no message ordering is enforced.
- Returns:
- The default unit of order name associated with
this connection factory
setDefaultUnitOfOrder
void setDefaultUnitOfOrder(String defaultUnitOfOrder)
throws IllegalArgumentException
Sets the value of the DefaultUnitOfOrder attribute.
- Parameters:
defaultUnitOfOrder
- The default unit of order name
- Throws:
IllegalArgumentException
- See Also:
DefaultDeliveryParamsBean.getDefaultUnitOfOrder()
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Copyright 1996, 2013, 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.1.2)
Part Number E27170-02
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD