weblogic.management.configuration
Interface JMSDestCommonMBean

All Superinterfaces:

ConfigurationMBean, JMSConstants

All Known Subinterfaces:

JMSDestinationMBean, JMSQueueMBean, JMSTemplateMBean, JMSTopicMBean

public interface JMSDestCommonMBean
extends ConfigurationMBean, JMSConstants

This class represents common JMS destination and JMS template methods.

A JMS destination identifies either a queue (Point-To-Point) or a topic (Pub/Sub) for a JMS server. A JMS template provides an efficient means of defining multiple destinations with similar attribute settings.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX."

getDestinationKeys

JMSDestinationKeyMBean[] getDestinationKeys()

Deprecated. 

A read-only array of the destination keys of the JMS template or destination. Destination keys define the sort order for messages that arrive on a specific destination. The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID property can only be the last key in the list.

Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "ascending" (first-in, first-out) for the sort order.

addDestinationKey

boolean addDestinationKey(JMSDestinationKeyMBean destinationKey)

Deprecated. 

Add a destination key to the JMS template or destination. Destination keys define the sort order for messages that arrive on a specific destination. The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID property can only be the last key in the list.

Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "ascending" (first-in, first-out) for the sort order.

Parameters:

destinationKey - a reference to JMSDestinationKeyMBean

setDestinationKeys

void setDestinationKeys(JMSDestinationKeyMBean[] keys)
                        throws InvalidAttributeValueException

Deprecated. 

Sets the value of the DestinationKeys attribute.

Parameters:

keys - an array of JMSDestinationKeyMBean

Throws:

InvalidAttributeValueException

See Also:

JMSDestCommonMBean.getDestinationKeys()

removeDestinationKey

boolean removeDestinationKey(JMSDestinationKeyMBean destinationKey)

Deprecated. 

Remove a destination key from the JMS template or destination. Destination keys define the sort order for messages that arrive on a specific destination. The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID property can only be the last key in the list.

Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "ascending" (first-in, first-out) for the sort order.

Parameters:

destinationKey - a reference to JMSDestinationKeyMBean

getBytesMaximum

long getBytesMaximum()

Deprecated. 

The maximum bytes quota (between 0 and a positive 64-bit integer) that can be stored in this destination. The default value of -1 specifies that there is no WebLogic-imposed limit on the number of bytes that can be stored in the destination. However, excessive bytes volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load.

Range of Values: >= BytesThresholdHigh.

This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

Note: If a JMS template is used for distributed destination members, then this setting applies only to those specific members and not the distributed destination set as a whole.

setBytesMaximum

void setBytesMaximum(long bytesMaximum)
                     throws InvalidAttributeValueException,
                            DistributedManagementException

Deprecated. 

Sets the value of the BytesMaximum attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getBytesMaximum()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getBytesThresholdHigh

long getBytesThresholdHigh()

Deprecated. 

The upper threshold value that triggers events based on the number of bytes stored in this JMS server. If the number of bytes exceeds this threshold, the following events are triggered :

• Log Messages

  - A message is logged on the server indicating a high threshold condition.

• Flow Control

  - If flow control is enabled, the destination becomes armed and instructs producers to begin decreasing their message flow.

A value of -1 specifies that flow control and threshold log messages are disabled for the destination.

Range of Values: Between 0 and a positive 64-bit integer; <= BytesMaximum; >BytesThresholdLow.

Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

setBytesThresholdHigh

void setBytesThresholdHigh(long bytesThresholdHigh)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Deprecated. 

Sets the value of the BytesThresholdHigh attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getBytesThresholdHigh()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getBytesThresholdLow

long getBytesThresholdLow()

Deprecated. 

The lower threshold value (between 0 and a positive 64-bit integer) that triggers events based on the number of bytes stored in this JMS server. If the number of bytes falls below this threshold, the following events are triggered:

• Log Messages

  - A message is logged on the server indicating that the threshold condition has cleared.

• Flow Control

  - If flow control is enabled, the destination becomes disarmed and instructs producers to begin increasing their message flow.

A value of -1 specifies that bytes paging, flow control, and threshold log messages are disabled for this JMS server.

Range of Values: < BytesThresholdHigh.

Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

setBytesThresholdLow

void setBytesThresholdLow(long bytesThresholdLow)
                          throws InvalidAttributeValueException,
                                 DistributedManagementException

Deprecated. 

Sets the value of the BytesThresholdLow attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getBytesThresholdLow()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getMessagesMaximum

long getMessagesMaximum()

Deprecated. 

The maximum message quota (total amount of messages) that can be stored in this JMS server. The default value of -1 specifies that there is no WebLogic-imposed limit on the number of messages that can be stored. However, excessive message volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load.

Range of Values: >= MessagesThresholdHigh.

Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

Note: If a JMS template is used for distributed destination members, then this setting applies only to those specific members and not the distributed destination set as a whole.

setMessagesMaximum

void setMessagesMaximum(long messagesMaximum)
                        throws InvalidAttributeValueException,
                               DistributedManagementException

Deprecated. 

Sets the value of the MessagesMaximum attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getMessagesMaximum()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getMessagesThresholdHigh

long getMessagesThresholdHigh()

Deprecated. 

The upper threshold value that triggers events based on the number of messages stored in this JMS server. If the number of messages exceeds this threshold, the following events are triggered:

• Log Messages

  - A message is logged on the server indicating a high threshold condition.

• Flow Control

  - If flow control is enabled, the destination becomes armed and instructs producers to begin decreasing their message flow.

A value of -1 specifies that bytes paging, flow control, and threshold log messages are disabled for this JMS server.

Range of Values: Between 0 and a positive 64-bit integer; <= MessagesMaximum; >MessagesThresholdLow.

Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

setMessagesThresholdHigh

void setMessagesThresholdHigh(long messagesThresholdHigh)
                              throws InvalidAttributeValueException,
                                     DistributedManagementException

Deprecated. 

Sets the value of the MessagesThresholdHigh attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getMessagesThresholdHigh()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getMessagesThresholdLow

long getMessagesThresholdLow()

Deprecated. 

The lower threshold value that triggers events based on the number of messages stored in this JMS server. If the number of messages falls below this threshold, the following events are triggered:

• Log Messages

  - A message is logged on the server indicating that the threshold condition has cleared.

• Flow Control

  - If flow control is enabled, the destination becomes disarmed and instructs producers to begin increasing their message flow.

A value of -1 specifies that bytes paging, flow control, and threshold log messages are disabled for this JMS server.

Range of Values: Between 0 and a positive 64-bit integer; < MessagesThresholdHigh.

This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

setMessagesThresholdLow

void setMessagesThresholdLow(long messagesThresholdLow)
                             throws InvalidAttributeValueException,
                                    DistributedManagementException

Deprecated. 

Sets the value of the MessagesThresholdLow attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getMessagesThresholdLow()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getPriorityOverride

int getPriorityOverride()

Deprecated. 

The priority assigned to all messages that arrive at the 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.

setPriorityOverride

void setPriorityOverride(int priorityOverride)
                         throws InvalidAttributeValueException,
                                DistributedManagementException

Deprecated. 

Sets the value of the PriorityOverride attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getPriorityOverride()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

JMSConstants.PRIORITY_MAXIMUM

Minimum Value:

-1

getTimeToDeliverOverride

String getTimeToDeliverOverride()

Deprecated. 

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 TimeToDeliverOverride can be specified either as a long or as a schedule.

Note: Changing the TimeToDeliverOverride only affects future message delivery, it does not affect message delivery of already produced messages.

See Also:

weblogic.jms.extensions.Schedule

setTimeToDeliverOverride

void setTimeToDeliverOverride(String timeToDeliverOverride)
                              throws InvalidAttributeValueException,
                                     DistributedManagementException

Deprecated. 

Sets the value of the TimeToDeliverOverride attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getTimeToDeliverOverride(), weblogic.jms.extensions.Schedule

Changes take effect after you redeploy the module or restart the server.

Default Value:

"-1"

getRedeliveryDelayOverride

long getRedeliveryDelayOverride()

Deprecated. 

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 RedeliveryDelayOverride only affects future rollbacks and recovers, it does not affect rollbacks and recovers that have already occurred.

setRedeliveryDelayOverride

void setRedeliveryDelayOverride(long redeliveryDelayOverride)
                                throws InvalidAttributeValueException,
                                       DistributedManagementException

Deprecated. 

Sets the value of the RedeliveryDelayOverride attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getRedeliveryDelayOverride()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

setErrorDestination

void setErrorDestination(JMSDestinationMBean errorDestination)
                         throws InvalidAttributeValueException,
                                DistributedManagementException

Deprecated. 

Sets the value of the ErrorDestination attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getErrorDestination()

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

getErrorDestination

JMSDestinationMBean getErrorDestination()

Deprecated. 

The destination for messages that have reached their redelivery limit, or for expired messages on the destination where the expiration policy is Redirect. If this destination has a template, (none) indicates that the error destination comes from the template. If this destination has no template, (none) indicates that there is no error destination configured.

Note: If a redelivery limit is specified, but no error destination is set, then messages that have reached their redelivery limit are simply discarded.

Note: The error destination must be a destination that is configured on the local JMS server.

Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

getRedeliveryLimit

int getRedeliveryLimit()

Deprecated. 

The number of redelivery tries (between 0 and a positive 32-bit integer) a message can have before it is moved to the error destination. This setting overrides any redelivery limit set by the message sender. If the redelivery limit is configured, but no error destination is configured, then persistent and non-persistent messages are simply dropped (deleted) when they reach their redelivery limit.

A value of -1 means that this value is inherited from the JMS template, if one is configured. If no JMS template is configured, then -1 means that there is no override.

Note: This attribute is dynamically configurable, but only incoming messages are impacted; previously sent messages continue to use their original redelivery limit.

Note: The number of times a message has been redelivered is not persisted. This means that after a restart, the number of delivery attempts on each message is reset to zero.

setRedeliveryLimit

void setRedeliveryLimit(int redeliveryLimit)
                        throws InvalidAttributeValueException,
                               DistributedManagementException

Deprecated. 

Sets the value of the RedeliveryLimit attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getRedeliveryLimit()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

-1

getTimeToLiveOverride

long getTimeToLiveOverride()

Deprecated. 

The time-to-live assigned to all messages that arrive at this topic, 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.

setTimeToLiveOverride

void setTimeToLiveOverride(long timeToLiveOverride)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Deprecated. 

Sets the value of the TimeToLiveOverride attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getTimeToLiveOverride()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getDeliveryModeOverride

String getDeliveryModeOverride()

Deprecated. 

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.

setDeliveryModeOverride

void setDeliveryModeOverride(String deliveryModeOverride)
                             throws InvalidAttributeValueException,
                                    DistributedManagementException

Deprecated. 

Sets the value of the DeliveryModeOverride attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getDeliveryModeOverride()

Changes take effect after you redeploy the module or restart the server.

Default Value:

JMSConstants.NO_DELIVERY

Valid Values:

JMSConstants.PERSISTENT,JMSConstants.NON_PERSISTENT,JMSConstants.NO_DELIVERY

setExpirationPolicy

void setExpirationPolicy(String policy)
                         throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ExpirationPolicy attribute.

Throws:

InvalidAttributeValueException

See Also:

JMSDestCommonMBean.getExpirationPolicy()

Changes take effect after you redeploy the module or restart the server.

Default Value:

JMSConstants.DISCARD

Valid Values:

JMSConstants.DISCARD,JMSConstants.LOGGING,JMSConstants.ERRORDESTINATION

getExpirationPolicy

String getExpirationPolicy()

Deprecated. 

The message Expiration Policy uses when an expired message is encountered on a destination.

The valid expiration policies are:

None - Same as the Discard policy; expired messages are simply removed from the destination.

Discard - Removes expired messages from the messaging system. The removal is not logged and the message is not redirected to another location. If no value is defined for a given destination (i.e., None), then expired messages are discarded.

Log - Removes expired messages from the system and writes an entry to the server log file indicating that the messages have been removed from the system. The actual information that is logged is defined by the Expiration Logging Policy.

Redirect - Moves expired messages from their current location to the Error Destination defined for the destination. The message retains its body, and all of its properties. The message also retains all of its header fields, but with the following exceptions:

• The destination for the message becomes the error destination.

• All property overrides associated with the error destination are applied to the redirected message.

• If there is no Time-To-Live Override value for the error destination, then the message receives a new Expiration Time of zero (indicating that it will not expire again

It is illegal to use the Redirect policy when there is no valid error destination defined for the destination. Similarly, it is illegal to remove the error destination for a destination that is using the Redirect policy.

Note: The Maximum Message quota is only enforced for sending new messages. It is ignored when moving messages because of the Redirect policy.

See Also:

JMSDestCommonMBean.setExpirationPolicy(java.lang.String)

Changes take effect after you redeploy the module or restart the server.

Default Value:

JMSConstants.DISCARD

Valid Values:

JMSConstants.DISCARD,JMSConstants.LOGGING,JMSConstants.ERRORDESTINATION

setExpirationLoggingPolicy

void setExpirationLoggingPolicy(String jmsPolicyString)
                                throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ExpirationLoggingPolicy attribute.

Throws:

InvalidAttributeValueException

See Also:

JMSDestCommonMBean.getExpirationLoggingPolicy()

Changes take effect after you redeploy the module or restart the server.

getExpirationLoggingPolicy

String getExpirationLoggingPolicy()

Deprecated. 

The policy that defines what information about the message is logged when the Expiration Policy on this destination is set to Log.

The valid logging policy values are:

• %header%

  - All JMS header fields are logged.

• %properties%

  - All user-defined properties are logged.

• JMSDeliveryTime

  - This WebLogic JMS-specific extended header field is logged.

• JMSRedeliveryLimit

  - This WebLogic JMS-specific extended header field is logged.

• foo

  - Any valid JMS header field or user-defined property is logged.

When specifying multiple values, enter them as a comma-separated list. The %header% and %properties% values are not case sensitive. For example, you could use "%header%,%properties%" for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use "%header, name, address, city, state, zip".N

Note: The JMSMessageID field is always logged and cannot be turned off. Therefore, if the Expiration Logging Policy is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the JMSMessageID of the message.

getMaximumMessageSize

int getMaximumMessageSize()

Deprecated. 

The maximum size of a message in bytes that will be accepted from producers on this JMS server. The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType. Producers sending messages that exceed the configured maximum message size for the JMS server receive a ResourceAllocationException.

Range of Values: Between 0 and a positive 32-bit integer.

The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the Range of Values: the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.

Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

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

setMaximumMessageSize

void setMaximumMessageSize(int maxMessageSize)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Deprecated. 

Sets the value of the MaximumMessageSize attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSDestCommonMBean.getMaximumMessageSize()

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

setCreationTime

void setCreationTime(long time)

Deprecated.