SettableBean
public interface DefaultDeliveryParamsBean extends SettableBean
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.
Modifier and Type | Method | Description |
---|---|---|
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.
|
java.lang.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.
|
java.lang.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.
|
java.lang.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(java.lang.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(java.lang.String defaultTimeToDeliver) |
Sets the value of the DefaultTimeToDeliver attribute.
|
void |
setDefaultTimeToLive(long defaultTimeToLive) |
Sets the value of the DefaultTimeToLive attribute.
|
void |
setDefaultUnitOfOrder(java.lang.String defaultUnitOfOrder) |
Sets the value of the DefaultUnitOfOrder attribute.
|
void |
setSendTimeout(long sendTimeout) |
Sets the value of the SendTimeout attribute.
|
java.lang.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(java.lang.String defaultDeliveryMode) throws java.lang.IllegalArgumentException
Sets the value of the DefaultDeliveryMode attribute.
defaultDeliveryMode
- The new default delivery modejava.lang.IllegalArgumentException
getDefaultDeliveryMode()
java.lang.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(java.lang.String defaultTimeToDeliver) throws java.lang.IllegalArgumentException
Sets the value of the DefaultTimeToDeliver attribute.
defaultTimeToDeliver
- The new default time to deliver valuejava.lang.IllegalArgumentException
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.
void setDefaultTimeToLive(long defaultTimeToLive) throws java.lang.IllegalArgumentException
Sets the value of the DefaultTimeToLive attribute.
defaultTimeToLive
- The new default time to live valuejava.lang.IllegalArgumentException
getDefaultTimeToLive()
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.
void setDefaultPriority(int defaultPriority) throws java.lang.IllegalArgumentException
Sets the value of the DefaultPriority attribute.
defaultPriority
- The new default priority valuejava.lang.IllegalArgumentException
getDefaultPriority()
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.
void setDefaultRedeliveryDelay(long defaultRedeliveryDelay) throws java.lang.IllegalArgumentException
Sets the value of the DefaultRedeliveryDelay attribute.
defaultRedeliveryDelay
- The new default redelivery delayjava.lang.IllegalArgumentException
getDefaultRedeliveryDelay()
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.
void setSendTimeout(long sendTimeout) throws java.lang.IllegalArgumentException
Sets the value of the SendTimeout attribute.
sendTimeout
- The send timeout value that a sender should wait in millisecondsjava.lang.IllegalArgumentException
getSendTimeout()
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:
void setDefaultCompressionThreshold(int threshold) throws java.lang.IllegalArgumentException
Sets the value of the CompressionThreshold attribute.
threshold
- The compression threshold new connections should usejava.lang.IllegalArgumentException
getDefaultCompressionThreshold()
java.lang.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.
void setDefaultUnitOfOrder(java.lang.String defaultUnitOfOrder) throws java.lang.IllegalArgumentException
Sets the value of the DefaultUnitOfOrder attribute.
defaultUnitOfOrder
- The default unit of order namejava.lang.IllegalArgumentException
getDefaultUnitOfOrder()