WebLogic Server 6.1 API Reference

weblogic.management.configuration
Interface JMSDestCommonMBean

All Known Subinterfaces:

JMSDestinationMBean, JMSQueueMBean, JMSTemplateMBean, JMSTopicMBean

public interface JMSDestCommonMBean

extends ConfigurationMBean, JMSConstants

A JMS destination template.

Author:

Copyright © 2001 BEA Systems, Inc. All Rights Reserved.

Fields inherited from class weblogic.management.configuration.JMSConstants

ACKNOWLEDGE_ALL, ACKNOWLEDGE_MODE_AUTO, ACKNOWLEDGE_MODE_CLIENT, ACKNOWLEDGE_MODE_DUPS_OK, ACKNOWLEDGE_MODE_NONE, ACKNOWLEDGE_ONE, ACKNOWLEDGE_PREVIOUS, DESTINATION_TYPE_QUEUE, DESTINATION_TYPE_TOPIC, ENABLED_DEFAULT, ENABLED_FALSE, ENABLED_TRUE, KEEP_NEW, KEEP_OLD, KEY_DIRECTION_ASCENDING, KEY_DIRECTION_DESCENDING, KEY_TYPE_BOOLEAN, KEY_TYPE_BYTE, KEY_TYPE_DOUBLE, KEY_TYPE_FLOAT, KEY_TYPE_INT, KEY_TYPE_LONG, KEY_TYPE_SHORT, KEY_TYPE_STRING, NO_DELIVERY, NON_PERSISTENT, PERSISTENT, PRIORITY_DEFAULT, PRIORITY_MAXIMUM, PRIORITY_MINIMUM, STORE_ENABLED_DEFAULT, STORE_ENABLED_FALSE, STORE_ENABLED_TRUE, STORE_TYPE_FILE, STORE_TYPE_JDBC, TRANSACTION_MODE_51, TRANSACTION_MODE_NONE, TRANSACTION_MODE_XA

Method Summary

boolean	addDestinationKey(JMSDestinationKeyMBean destinationKey) Add a destination key to the template or destination.
long	getBytesMaximum() Returns the value of bytesMaximum.
long	getBytesThresholdHigh() Returns the value of bytesThresholdHigh.
long	getBytesThresholdLow() Returns the value of bytesThresholdLow.
java.lang.String	getDeliveryModeOverride() The deliveryModeOverride attribute defines the delivery mode assigned to all messages that arrive at the destination regardless of the delivery mode specified by the producer.
JMSDestinationKeyMBean[]	getDestinationKeys() Return a read-only array of the destination keys of the template or destination.
JMSDestinationMBean	getErrorDestination() Returns the error destination for messages that have reach their redelivery limit.
long	getMessagesMaximum() Returns the value of messagesMaximum.
long	getMessagesThresholdHigh() Returns the value of messagesThresholdHigh.
long	getMessagesThresholdLow() Returns the value of messagesThresholdLow.
int	getPriorityOverride() Returns the priority override value.
long	getRedeliveryDelayOverride() Returns the redelivery delay override in milliseconds for rollbacks and recoveries of consumed messages.
int	getRedeliveryLimit() Returns the number of redelivery tries a message may have before it is placed in the error destination.
java.lang.String	getTimeToDeliverOverride() Returns the time-to-deliver override value either in milliseconds or as a schedule.
long	getTimeToLiveOverride() The timeToLiveOverride attribute defines the time-to-live assigned to all messages that arrive at the destination, regardless of the time-to-live specified by the producer.
boolean	removeDestinationKey(JMSDestinationKeyMBean destinationKey) Remove a destination key from the template or destination.
void	setBytesMaximum(long bytesMaximum) Set the value of bytesMaximum.
void	setBytesThresholdHigh(long bytesThresholdHigh) Set the value of bytesThresholdHigh.
void	setBytesThresholdLow(long bytesThresholdLow) Set the value of bytesThresholdLow.
void	setDeliveryModeOverride(java.lang.String deliveryModeOverride) The deliveryModeOverride attribute is dynamic.
void	setDestinationKeys(JMSDestinationKeyMBean[] keys) Set the list of potential destination keys for the template or destination.
void	setErrorDestination(JMSDestinationMBean errorDestination) The errorDestination attribute defines the name of the target destination for messages that have reached their redelivery limit.
void	setMessagesMaximum(long messagesMaximum) Set the value of messagesMaximum.
void	setMessagesThresholdHigh(long messagesThresholdHigh) Set the value of messagesThresholdHigh.
void	setMessagesThresholdLow(long messagesThresholdLow) Set the value of messagesThresholdLow.
void	setPriorityOverride(int priorityOverride) Set the priority override value.
void	setRedeliveryDelayOverride(long redeliveryDelayOverride) The redeliveryDelayOverride attribute defines the delay in milliseconds before rolled back or recovered messages are redelivered, regardless of the redelivery-delay specified by the consumer and/or connection factory.
void	setRedeliveryLimit(int redeliveryLimit) The redeliveryLimit attribute defines the number of redelivery tries a message may have before it is placed in the error destination.
void	setTimeToDeliverOverride(java.lang.String timeToDeliverOverride) The timeToDeliverOverride value defines the delay in milliseconds before a produced message is made visible on its target destination, regardless of the time-to-deliver specified by the producer and/or connection factory.
void	setTimeToLiveOverride(long timeToLiveOverride) The timeToLiveOverride attribute is dynamic.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

getNotes, setNotes, setPersistenceEnabled

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Method Detail

getDestinationKeys

public JMSDestinationKeyMBean[] getDestinationKeys()

Return a read-only array of the destination keys of the template or destination.

addDestinationKey

public boolean addDestinationKey(JMSDestinationKeyMBean destinationKey)

Add a destination key to the template or destination.

Parameters:

destinationKey - a reference to JMSDestinationKeyMBean

setDestinationKeys

public void setDestinationKeys(JMSDestinationKeyMBean[] keys)
                        throws javax.management.InvalidAttributeValueException

Set the list of potential destination keys for the template or destination.

Legal Value: (weblogic.management.configuration.JMSLegalHelper.legalOrder(((weblogic.management.configuration.JMSDestCommonMBean)self).getDestinationKeys(), value))

Parameters:

destinationKeys - an array of JMSDestinationKeyMBean

removeDestinationKey

public boolean removeDestinationKey(JMSDestinationKeyMBean destinationKey)

Remove a destination key from the template or destination.

Parameters:

destinationKey - a reference to JMSDestinationKeyMBean

getBytesMaximum

public long getBytesMaximum()

Returns the value of bytesMaximum.

This is the maximum number of bytes that may be stored in the destination. A value of -1 specifies that there is no limit on the number of bytes that can be stored in the destination.

setBytesMaximum

public void setBytesMaximum(long bytesMaximum)
                     throws javax.management.InvalidAttributeValueException,
                            DistributedManagementException

Set the value of bytesMaximum. This is the maximum number of bytes that may be stored in the destination. A value of -1 specifies that there is no limit on the number of bytes that can be stored in the destination.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((value >= 0) && (value >= ((weblogic.management.configuration.JMSDestCommonMBean)self).getBytesThresholdHigh()) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getBytesThresholdHigh

public long getBytesThresholdHigh()

Returns the value of bytesThresholdHigh. This value is the upper threshold that triggers events based on the number of bytes stored in the destination. A value of -1 specifies that threshold events are disabled for the destination.

setBytesThresholdHigh

public void setBytesThresholdHigh(long bytesThresholdHigh)
                           throws javax.management.InvalidAttributeValueException,
                                  DistributedManagementException

Set the value of bytesThresholdHigh. This value is the upper threshold that triggers events based on the number of bytes stored in the destination. A value of -1 specifies that threshold events are disabled for the destination.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || (((( weblogic.management.configuration.JMSDestCommonMBean)self).getBytesThresholdLow() < value) && ((((weblogic.management.configuration.JMSDestCommonMBean)self).getBytesMaximum() == -1) || (value <= ((weblogic.management.configuration.JMSDestCommonMBean)self).getBytesMaximum())) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getBytesThresholdLow

public long getBytesThresholdLow()

Returns the value of bytesThresholdLow. This value is the lower threshold that triggers events based on the number of bytes stored in the destination. A value of -1 specifies that threshold events are disabled for the destination

setBytesThresholdLow

public void setBytesThresholdLow(long bytesThresholdLow)
                          throws javax.management.InvalidAttributeValueException,
                                 DistributedManagementException

Set the value of bytesThresholdLow. This value is the lower threshold that triggers events based on the number of bytes stored in the destination. A value of -1 specifies that threshold events are disabled for the destination

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((0 <= value) && (((weblogic.management.configuration.JMSDestCommonMBean)self).getBytesThresholdHigh() == -1 || value < ((weblogic.management.configuration.JMSDestCommonMBean)self).getBytesThresholdHigh()) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getMessagesMaximum

public long getMessagesMaximum()

Returns the value of messagesMaximum. This value is the maximum number of messages that may be stored in the destination. A value of -1 specifies that there is no limit on the number of messages that can be stored in the destination.

setMessagesMaximum

public void setMessagesMaximum(long messagesMaximum)
                        throws javax.management.InvalidAttributeValueException,
                               DistributedManagementException

Set the value of messagesMaximum. This value is the maximum number of messages that may be stored in the destination. A value of -1 specifies that there is no limit on the number of messages that can be stored in the destination.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((value >= 0) && (value >= ((weblogic.management.configuration.JMSDestCommonMBean)self).getMessagesThresholdHigh()) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getMessagesThresholdHigh

public long getMessagesThresholdHigh()

Returns the value of messagesThresholdHigh. This value is the upper threshold that triggers events based on the number of messages stored in the destination. A value of -1 specifies that threshold events are disabled for the destination.

setMessagesThresholdHigh

public void setMessagesThresholdHigh(long messagesThresholdHigh)
                              throws javax.management.InvalidAttributeValueException,
                                     DistributedManagementException

Set the value of messagesThresholdHigh. This value is the upper threshold that triggers events based on the number of messages stored in the destination. A value of -1 specifies that threshold events are disabled for the destination.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((((weblogic.management.configuration.JMSDestCommonMBean)self).getMessagesThresholdLow() < value) && ((((weblogic.management.configuration.JMSDestCommonMBean)self).getMessagesMaximum() == -1) || (value <= ((weblogic.management.configuration.JMSDestCommonMBean)self).getMessagesMaximum())) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getMessagesThresholdLow

public long getMessagesThresholdLow()

Returns the value of messagesThresholdLow. This value is the lower threshold that triggers events based on the number of messages stored in the destination. A value of -1 specifies that threshold events are disabled for the destination.

setMessagesThresholdLow

public void setMessagesThresholdLow(long messagesThresholdLow)
                             throws javax.management.InvalidAttributeValueException,
                                    DistributedManagementException

Set the value of messagesThresholdLow. This value is the lower threshold that triggers events based on the number of messages stored in the destination. A value of -1 specifies that threshold events are disabled for the destination.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((0 <= value) && (((weblogic.management.configuration.JMSDestCommonMBean)self).getMessagesThresholdHigh() == -1 || value < ((weblogic.management.configuration.JMSDestCommonMBean)self).getMessagesThresholdHigh()) && (value <= ((1 << 63) -1)))

Legal Minimum Value: -1

getPriorityOverride

public int getPriorityOverride()

Returns the priority override value. This value is 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 setting.

setPriorityOverride

public void setPriorityOverride(int priorityOverride)
                         throws javax.management.InvalidAttributeValueException,
                                DistributedManagementException

Set the priority override value. This value is 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 setting. The priorityOverride attribute is dynamic. It can be changed at anytime.

Note: Changing the priorityOverride attribute for a destination only affects incoming messages. It does not affect messages that are already stored in the destination.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((weblogic.management.configuration.JMSConstants.PRIORITY_MINIMUM <= value) && (value <= weblogic.management.configuration.JMSConstants.PRIORITY_MAXIMUM))

Legal Minimum Value: -1

Legal Maximum Value: weblogic.management.configuration.JMSConstants.PRIORITY_MAXIMUM

getTimeToDeliverOverride

public java.lang.String getTimeToDeliverOverride()

Returns the time-to-deliver override value either in milliseconds or as a schedule. This is the delay between when a message is produced and when it is made visible on its target destination. A value of -1 indicates no override is set.

See Also:

Schedule

setTimeToDeliverOverride

public void setTimeToDeliverOverride(java.lang.String timeToDeliverOverride)
                              throws javax.management.InvalidAttributeValueException,
                                     DistributedManagementException

The timeToDeliverOverride value defines the delay in milliseconds before a produced message is made visible on its target destination, regardless of the time-to-deliver specified by the producer and/or connection factory. The timeToDeliverOverride attribute is dynamic and can be changed at any time.

Note: Changing the timeToDeliverOverride attribute only affects future message delivery, it does not affect message delivery of already produced messages. A value of -1 indicates no override is set; this is the default. The timeToDeliverOverride may be specified either as a long or as a schedule.

A dynamic MBean attribute

Default Value: "-1"

Legal Value: (weblogic.management.configuration.JMSLegalHelper.legalTimeToDeliverOverride(value))

See Also:

Schedule

getRedeliveryDelayOverride

public long getRedeliveryDelayOverride()

Returns the redelivery delay override in milliseconds for rollbacks and recoveries of consumed messages. A value of -1 indicates no override is set.

setRedeliveryDelayOverride

public void setRedeliveryDelayOverride(long redeliveryDelayOverride)
                                throws javax.management.InvalidAttributeValueException,
                                       DistributedManagementException

The redeliveryDelayOverride attribute defines the delay in milliseconds before rolled back or recovered messages are redelivered, regardless of the redelivery-delay 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 redeliveryDelayOverride attribute is dynamic and can be changed at any time.

Note: Changing the redeliveryDelayOverride attribute only affects future rollbacks and recovers, it does not affect rollbacks and recovers that have already occurred. A value of -1 indicates no override is set; this is the default.

A dynamic MBean attribute

Default Value: -1

Legal Minimum Value: -1

getRedeliveryLimit

public int getRedeliveryLimit()

Returns the number of redelivery tries a message may have before it is placed in the error destination. If this limit is reached and no error destination is configured, or the quota for the error destination would be exceeded, then the message is simply deleted. A value of -1 indicates there is no limit on the number of redelivery attempts.

setErrorDestination

public void setErrorDestination(JMSDestinationMBean errorDestination)
                         throws javax.management.InvalidAttributeValueException,
                                DistributedManagementException

The errorDestination attribute defines the name of the target destination for messages that have reached their redelivery limit. If no error destination is configured, then such messages are simply deleted.

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

A dynamic MBean attribute

Default Value: null

Legal Value: ((value == void)?(true):(weblogic.management.configuration.JMSLegalHelper.legalErrorDestination(self, value)))

getErrorDestination

public JMSDestinationMBean getErrorDestination()

Returns the error destination for messages that have reach their redelivery limit. If the error destination is null, then such messages are simply deleted.

setRedeliveryLimit

public void setRedeliveryLimit(int redeliveryLimit)
                        throws javax.management.InvalidAttributeValueException,
                               DistributedManagementException

The redeliveryLimit attribute defines the number of redelivery tries a message may have before it is placed in the error destination. If this limit is reached and no error destination is configured, or the quota for the error destination would be exceeded, then the message is simply deleted. Messages are redelivered when consumers either recover them or roll them back.

Redelivered queue messages are put back into their originating destination; redelivered topic messages are put back into their originating subscription if their redelivery limit has not been reached. The redeliveryLimit attribute is dynamic and can be changed at anytime.

Note: Changing the redeliveryLimit attribute does not affect messages that have already reached this limit. The next time such messages are redelivered, they will immediately be redirected to the error destination. The number of times of 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. A value of -1 indicates there is no limit on the number of redelivery attempts.

A dynamic MBean attribute

Default Value: -1

Legal Minimum Value: -1

getTimeToLiveOverride

public long getTimeToLiveOverride()

The timeToLiveOverride attribute defines the time-to-live assigned to all messages that arrive at the destination, regardless of the time-to-live specified by the producer. The default value for the timeToLiveOverride attribute is -1, indicating that the time-to-live is not being overridden.

setTimeToLiveOverride

public void setTimeToLiveOverride(long timeToLiveOverride)
                           throws javax.management.InvalidAttributeValueException,
                                  DistributedManagementException

The timeToLiveOverride attribute is dynamic. It can be changed at anytime.

Note: Changing the timeToLiveOverride attribute for a destination only affects incoming messages. It does not affect messages that are already stored in the destination. A value of -1 indicates that no override is set.

A dynamic MBean attribute

Default Value: -1

Legal Minimum Value: -1

Legal Maximum Value: java.lang.Long.MAX_VALUE

getDeliveryModeOverride

public java.lang.String getDeliveryModeOverride()

The deliveryModeOverride attribute defines the delivery mode assigned to all messages that arrive at the destination regardless of the delivery mode specified by the producer. The default value for the deliveryModeOverride attribute is NO_DELIVERY, indicating that the delivery mode is not being overridden.

setDeliveryModeOverride

public void setDeliveryModeOverride(java.lang.String deliveryModeOverride)
                             throws javax.management.InvalidAttributeValueException,
                                    DistributedManagementException

The deliveryModeOverride attribute is dynamic. It can be changed at anytime.

Note: Changing the deliveryModeOverride attribute for a destination only affects incoming messages. It does not affect messages that are already stored in the destination.

A dynamic MBean attribute

Default Value: weblogic.management.configuration.JMSConstants.NO_DELIVERY

Legal Values: weblogic.management.configuration.JMSConstants.PERSISTENT,weblogic.management.configuration.JMSConstants.NON_PERSISTENT,weblogic.management.configuration.JMSConstants.NO_DELIVERY