BEA Systems, Inc.

WebLogic Server 6.1 API Reference

weblogic.management.configuration
Interface JMSDestinationMBean

All Known Subinterfaces:
JMSQueueMBean, JMSTopicMBean

public interface JMSDestinationMBean
extends JMSDestCommonMBean, JMSConstants

A JMS Destination. This can be a queue or a topic.

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
 
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
 java.lang.String getBytesPagingEnabled()
          One of "true", "false", or "default".
 java.lang.String getJNDIName()
          Returns the JNDI name of the destination.
 java.lang.String getMessagesPagingEnabled()
          One of "true", "false", or "default".
 java.lang.String getStoreEnabled()
          One of "true", "false", or "default".
 JMSTemplateMBean getTemplate()
          Return the template from which the destination is derived.
 boolean isJNDINameReplicated()
          If JNDINameReplicated is set to true then the JNDI name for the destination (if present) is replicated across the cluster.
 void setBytesPagingEnabled(java.lang.String enabled)
          Set BytesPagingEnabled for the destination.
 void setJNDIName(java.lang.String name)
          Set the JNDI name of a destination.
 void setJNDINameReplicated(boolean replicated)
          If JNDINameReplicated is set to true then the JNDI name for the destination (if present) is replicated across the cluster.
 void setMessagesPagingEnabled(java.lang.String enabled)
          Set MessagesPagingEnabled for the destination.
 void setStoreEnabled(java.lang.String storeEnabled)
          Enable/disable storing persistent (durable) messages for this destination using the server's store.
 void setTemplate(JMSTemplateMBean template)
          Set the template from which the destination is derived.
 
Methods inherited from interface weblogic.management.configuration.JMSDestCommonMBean
addDestinationKey, getBytesMaximum, getBytesThresholdHigh, getBytesThresholdLow, getDeliveryModeOverride, getDestinationKeys, getErrorDestination, getMessagesMaximum, getMessagesThresholdHigh, getMessagesThresholdLow, getPriorityOverride, getRedeliveryDelayOverride, getRedeliveryLimit, getTimeToDeliverOverride, getTimeToLiveOverride, removeDestinationKey, setBytesMaximum, setBytesThresholdHigh, setBytesThresholdLow, setDeliveryModeOverride, setDestinationKeys, setErrorDestination, setMessagesMaximum, setMessagesThresholdHigh, setMessagesThresholdLow, setPriorityOverride, setRedeliveryDelayOverride, setRedeliveryLimit, setTimeToDeliverOverride, setTimeToLiveOverride
 
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

getTemplate

public JMSTemplateMBean getTemplate()
Return the template from which the destination is derived. If this attribute is not defined, then the attributes for the destination must be specified as part of the destination.


setTemplate

public void setTemplate(JMSTemplateMBean template)
                 throws javax.management.InvalidAttributeValueException
Set the template from which the destination is derived. If this attribute is not defined, then the attributes for the destination must be specified as part of the destination.


getJNDIName

public java.lang.String getJNDIName()
Returns the JNDI name of the destination. This value is the name used to look up the destination within the JNDI namespace. If not specified, the destination name is not advertised through the JNDI namespace.


setJNDIName

public void setJNDIName(java.lang.String name)
                 throws javax.management.InvalidAttributeValueException
Set the JNDI name of a destination. This value is the name used to look up the destination within the JNDI namespace. If not specified, the destination name is not advertised through the JNDI namespace.


isJNDINameReplicated

public boolean isJNDINameReplicated()
If JNDINameReplicated is set to true then the JNDI name for the destination (if present) is replicated across the cluster. If JNDINameReplicated is set to false, then the JNDI name for the destination (if present) is only visible from the server of which this destination is a part.


setJNDINameReplicated

public void setJNDINameReplicated(boolean replicated)
                           throws javax.management.InvalidAttributeValueException
If JNDINameReplicated is set to true then the JNDI name for the destination (if present) is replicated across the cluster. If JNDINameReplicated is set to false, then the JNDI name for the destination (if present) is only visible from the server of which this destination is a part.

Default Value: true

getStoreEnabled

public java.lang.String getStoreEnabled()
One of "true", "false", or "default". This is a string specifying whether or not the destination uses the backing store specified by the JMS server. If this string is "true", but no backing store is defined, then the configuration fails and WebLogic JMS does not boot. If this value is "false", then the destination does not support persistent messages. If this flag is set to "default", then the destination uses the backing store if one is defined.


setStoreEnabled

public void setStoreEnabled(java.lang.String storeEnabled)
                     throws javax.management.InvalidAttributeValueException
Enable/disable storing persistent (durable) messages for this destination using the server's store.
   "true"     Enabled, configuration error if server has no associated store.
   "false"    Disabled, peristent may be downgraded to non-persistent.
   "default"  Enabled if server has associated store, disabled otherwise.
 

Default Value: weblogic.management.configuration.JMSConstants.ENABLED_DEFAULT
Legal Values: weblogic.management.configuration.JMSConstants.ENABLED_DEFAULT,weblogic.management.configuration.JMSConstants.ENABLED_FALSE,weblogic.management.configuration.JMSConstants.ENABLED_TRUE FIXME pcal 02-Oct-00 Something is broken with mbeanc - it isn't picking up the legal values unless the classes are fully-specified.

getMessagesPagingEnabled

public java.lang.String getMessagesPagingEnabled()
One of "true", "false", or "default". This is a string specifying whether or not the template or destination allows paging. If this string is "true", the destination will start paging out messages once the MessagesThresholdHigh is reached. If this value is "false", then the destination does not support paging. For a template, the "default" value is equivalent to "false". For a destination, the "default" value means the destination will use its template's value. If no template configured for the destination, the "default" value is equivalent to "false".


setMessagesPagingEnabled

public void setMessagesPagingEnabled(java.lang.String enabled)
                              throws javax.management.InvalidAttributeValueException
Set MessagesPagingEnabled for the destination.

Default Value: weblogic.management.configuration.JMSConstants.ENABLED_DEFAULT
Legal Values: weblogic.management.configuration.JMSConstants.ENABLED_DEFAULT,weblogic.management.configuration.JMSConstants.ENABLED_FALSE,weblogic.management.configuration.JMSConstants.ENABLED_TRUE

getBytesPagingEnabled

public java.lang.String getBytesPagingEnabled()
One of "true", "false", or "default". This is a string specifying whether or not the template or destination allows paging. If this string is "true", the destination will start paging out messages once the BytesThresholdHigh is reached. If this value is "false", then the destination does not support paging. For a template, the "default" value is equivalent to "false". For a destination, the "default" value means the destination will use its template's value. If no template configured for the destination, the "default" value is equivalent to "false".


setBytesPagingEnabled

public void setBytesPagingEnabled(java.lang.String enabled)
                           throws javax.management.InvalidAttributeValueException
Set BytesPagingEnabled for the destination.

Default Value: weblogic.management.configuration.JMSConstants.ENABLED_DEFAULT
Legal Values: weblogic.management.configuration.JMSConstants.ENABLED_DEFAULT,weblogic.management.configuration.JMSConstants.ENABLED_FALSE,weblogic.management.configuration.JMSConstants.ENABLED_TRUE

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs61

WebLogic classes and methods that do not appear in this reference are not public and are not supported.