SettableBean
public interface DeliveryParamsOverridesBean extends SettableBean
Many delivery parameters can be set by the JMS client. These overrides, if set, will cause those specific parameters to be ignored and replaced by the value set here.
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getDeliveryMode() |
The delivery mode assigned to all messages that arrive at the
destination regardless of the DeliveryMode specified by the message
producer.
|
int |
getPriority() |
The priority assigned to all messages that arrive at this
destination, regardless of the Priority specified by the message
producer.
|
long |
getRedeliveryDelay() |
The delay, in milliseconds, before rolled back or recovered
messages are redelivered, regardless of the RedeliveryDelay
specified by the consumer and/or connection factory.
|
TemplateBean |
getTemplateBean() |
This is used to find the template bean for this destination
|
java.lang.String |
getTimeToDeliver() |
The default delay, either in milliseconds or as a schedule,
between when a message is produced and when it is made visible on
its target destination, regardless of the delivery time specified
by the producer and/or connection factory.
|
long |
getTimeToLive() |
The time-to-live assigned to all messages that arrive at this
destination, regardless of the TimeToLive value specified by the message
producer.
|
void |
setDeliveryMode(java.lang.String deliveryMode) |
Sets the value of the DeliveryMode attribute.
|
void |
setPriority(int priority) |
Sets the value of the Priority override attribute.
|
void |
setRedeliveryDelay(long redeliveryDelay) |
Sets the value of the RedeliveryDelay override attribute.
|
void |
setTimeToDeliver(java.lang.String timeToDeliver) |
Sets the value of the TimeToDeliver override attribute.
|
void |
setTimeToLive(long timeToLive) |
Sets the value of the TimeToLive override attribute.
|
java.lang.String getDeliveryMode()
The delivery mode assigned to all messages that arrive at the destination regardless of the DeliveryMode specified by the message producer.
A value of No-Delivery
specifies that the DeliveryMode
will not be overridden.
Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
void setDeliveryMode(java.lang.String deliveryMode) throws java.lang.IllegalArgumentException
Sets the value of the DeliveryMode attribute.
deliveryMode
- The delivery mode override that should be used with this destinationjava.lang.IllegalArgumentException
getDeliveryMode()
java.lang.String getTimeToDeliver()
The default delay, either in milliseconds or as a schedule,
between when a message is produced and when it is made visible on
its target destination, regardless of the delivery time specified
by the producer and/or connection factory. The default value
(-1
) specifies that the destination will not override the
TimeToDeliver setting specified by the producer and/or connection
factory. The TimeToDeliver override can be specified either as a
long or as a schedule.
Note: Changing the TimeToDeliver override only affects future message delivery, it does not affect message delivery of already produced messages.
Schedule
void setTimeToDeliver(java.lang.String timeToDeliver) throws java.lang.IllegalArgumentException
Sets the value of the TimeToDeliver override attribute.
timeToDeliver
- The time to deliver override that should be used with this
destination or -1 if there should be no time to deliver overridejava.lang.IllegalArgumentException
getTimeToDeliver()
,
Schedule
long getTimeToLive()
The time-to-live assigned to all messages that arrive at this
destination, regardless of the TimeToLive value specified by the message
producer. The default value (-1
) specifies that this
setting will not override the TimeToLive setting specified by the
message producer.
Range of Values: Between 0 and a positive 64-bit integer.
Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
void setTimeToLive(long timeToLive) throws java.lang.IllegalArgumentException
Sets the value of the TimeToLive override attribute.
timeToLive
- The time to live override for this destination or -1 if
there should be no time to live overridejava.lang.IllegalArgumentException
getTimeToLive()
int getPriority()
The priority assigned to all messages that arrive at this destination, regardless of the Priority specified by the message producer. The default value (-1) specifies that the destination will not override the Priority set by the message producer.
Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
void setPriority(int priority) throws java.lang.IllegalArgumentException
Sets the value of the Priority override attribute.
priority
- The priority override for this destination or -1 if there is no
priority override for this destinationjava.lang.IllegalArgumentException
getPriority()
long getRedeliveryDelay()
The delay, in milliseconds, before rolled back or recovered messages are redelivered, regardless of the RedeliveryDelay specified by the consumer and/or connection factory. Redelivered queue messages are put back into their originating destination; redelivered topic messages are put back into their originating subscription. The default value (-1) specifies that the destination will not override the RedeliveryDelay setting specified by the consumer and/or connection factory.
Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: Changing the RedeliveryDelay override only affects future rollbacks and recovers, it does not affect rollbacks and recovers that have already occurred.
void setRedeliveryDelay(long redeliveryDelay) throws java.lang.IllegalArgumentException
Sets the value of the RedeliveryDelay override attribute.
redeliveryDelay
- The redelivery delay override for this destination or -1 if
there is no redelivery delay overridejava.lang.IllegalArgumentException
getRedeliveryDelay()
TemplateBean getTemplateBean()
This is used to find the template bean for this destination