weblogic.j2ee.descriptor.wl

Interface DeliveryParamsOverridesBean

All Superinterfaces:

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.

Access limited to the following security roles:

Deployer

Method Summary

Modifier and Type	Method and Description
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
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(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(String timeToDeliver) Sets the value of the TimeToDeliver override attribute.
void	setTimeToLive(long timeToLive) Sets the value of the TimeToLive override attribute.

Method Detail

getDeliveryMode

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.

Returns:

The current delivery mode override

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.NO_DELIVERY

setDeliveryMode

void setDeliveryMode(String deliveryMode)
              throws IllegalArgumentException

Sets the value of the DeliveryMode attribute.

Parameters:

deliveryMode - The delivery mode override that should be used with this destination

Throws:

IllegalArgumentException

See Also:

DeliveryParamsOverridesBean.getDeliveryMode()

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.PERSISTENT,weblogic.j2ee.descriptor.wl.constants.JMSConstants.NON_PERSISTENT,weblogic.j2ee.descriptor.wl.constants.JMSConstants.NO_DELIVERY

getTimeToDeliver

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.

Returns:

The current time to deliver override for this destination

See Also:

Schedule

Default Value:

"-1"

setTimeToDeliver

void setTimeToDeliver(String timeToDeliver)
               throws IllegalArgumentException

Sets the value of the TimeToDeliver override attribute.

Parameters:

timeToDeliver - The time to deliver override that should be used with this destination or -1 if there should be no time to deliver override

Throws:

IllegalArgumentException

See Also:

DeliveryParamsOverridesBean.getTimeToDeliver(), Schedule

getTimeToLive

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.

Returns:

The time to live override for this destination

Default Value:

-1

setTimeToLive

void setTimeToLive(long timeToLive)
            throws IllegalArgumentException

Sets the value of the TimeToLive override attribute.

Parameters:

timeToLive - The time to live override for this destination or -1 if there should be no time to live override

Throws:

IllegalArgumentException

See Also:

DeliveryParamsOverridesBean.getTimeToLive()

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getPriority

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.

Returns:

The priority override for this destination

Default Value:

-1

setPriority

void setPriority(int priority)
          throws IllegalArgumentException

Sets the value of the Priority override attribute.

Parameters:

priority - The priority override for this destination or -1 if there is no priority override for this destination

Throws:

IllegalArgumentException

See Also:

DeliveryParamsOverridesBean.getPriority()

Maximum Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.PRIORITY_MAXIMUM

Minimum Value:

-1

getRedeliveryDelay

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.

Returns:

The redelivery delay override for this destination

Default Value:

-1

setRedeliveryDelay

void setRedeliveryDelay(long redeliveryDelay)
                 throws IllegalArgumentException

Sets the value of the RedeliveryDelay override attribute.

Parameters:

redeliveryDelay - The redelivery delay override for this destination or -1 if there is no redelivery delay override

Throws:

IllegalArgumentException

See Also:

DeliveryParamsOverridesBean.getRedeliveryDelay()

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getTemplateBean

TemplateBean getTemplateBean()

This is used to find the template bean for this destination

Returns:

The template bean that will be used for this destination, or null if this threshold bean is from a template or a template could not be found for this destination