Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06

weblogic.management.configuration
Interface JMSDestinationKeyMBean

All Superinterfaces:
ConfigurationMBean, JMSConstants

Deprecated. 8.1.0.0 Replaced by weblogic.j2ee.descriptor.wl.DestinationKeyBean

public interface JMSDestinationKeyMBean
extends ConfigurationMBean, JMSConstants

This class represents a key value for a destination, which is used to define the sort order of messages as they arrive on a destination.

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."

Access limited to the following security roles:
Deployer

Field Summary
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Fields inherited from interface weblogic.management.configuration.JMSConstants
ACKNOWLEDGE_ALL, ACKNOWLEDGE_MODE_AUTO, ACKNOWLEDGE_MODE_CLIENT, ACKNOWLEDGE_MODE_DUPS_OK, ACKNOWLEDGE_MODE_NONE, ACKNOWLEDGE_ONE, ACKNOWLEDGE_PREVIOUS, ALWAYSFORWARD, AT_LEAST_ONCE, AT_MOST_ONCE, AUTH_PRINS, CLIENT_ID_POLICY_RESTRICTED, CLIENT_ID_POLICY_UNRESTRICTED, CONSUMPTION_ENABLED, CONSUMPTION_PAUSED, CONSUMPTION_PAUSING, DEFAULT_MESSAGE_BUFFER_SIZE, DESTINATION_TYPE_QUEUE, DESTINATION_TYPE_TOPIC, DISABLED, DISCARD, ENABLED, ENABLED_DEFAULT, ENABLED_FALSE, ENABLED_TRUE, ERRORDESTINATION, EXACTLY_ONCE, EXPORT_TO_ALL, EXPORT_TO_NONE, FIFO, FORWARDING_POLICY_PARTITIONED, FORWARDING_POLICY_REPLICATED, INITIALCONTEXTFACTORY, INSERTION_ENABLED, INSERTION_PAUSED, INSERTION_PAUSING, 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, LOGGING, NEVER, NO_DELIVERY, NON_PERSISTENT, NON_XML, PASS_THROUGH, PAUSED_AT_STARTUP_DEFAULT, PAUSED_AT_STARTUP_FALSE, PAUSED_AT_STARTUP_TRUE, PERSISTENT, PREEMPTIVE, PRIORITY_DEFAULT, PRIORITY_MAXIMUM, PRIORITY_MINIMUM, PRODUCTION_ENABLED, PRODUCTION_PAUSED, PRODUCTION_PAUSING, RANDOM, ROUND_ROBIN, SEND_QUOTA_BLOCKING_TIMEOUT, SINGLE_MESSAGE, STORE_ENABLED_DEFAULT, STORE_ENABLED_FALSE, STORE_ENABLED_TRUE, STORE_TYPE_FILE, STORE_TYPE_JDBC, SUBSCRIPTION_EXCLUSIVE, SUBSCRIPTION_SHARABLE, SUPPORTS, SYNCWRITE_CACHEFLUSH, SYNCWRITE_DIRECTWRITE, SYNCWRITE_DISABLED, TOPIC_ONLY, TOPIC_SUBSCRIBER_ONLY, TRANSACTION_MODE_51, TRANSACTION_MODE_NONE, TRANSACTION_MODE_XA, UNITOFORDER_STANDARD, UNITOFORDER_SYSTEM, XML, XMLALL
 
Method Summary
 String getDirection()
          Deprecated. The direction (Ascending or Descending) in which this key will sort messages.
 String getKeyType()
          Deprecated. The expected sort key type for this JMS destination key.
 String getProperty()
          Deprecated. The message property name or the name of a message header field on which to sort.
 void setDirection(String direction)
          Deprecated. Sets the value of the Direction attribute.
 void setKeyType(String type)
          Deprecated. Sets the value of the KeyType attribute.
 void setProperty(String property)
          Deprecated. Sets the value of the Property attribute.
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
 

Method Detail

getProperty

String getProperty()
Deprecated. 

The message property name or the name of a message header field on which to sort. Message header field keys start with the letters "JMS" and ignore the Key Type field. (For better performance, use message header fields as sorting keys, rather than message properties.)

Range of Values: The JMS Property name (including user properties) or message header fields that can be sorted on are:

Note: This attribute is not dynamically configurable.

Returns:
The property value

setProperty

void setProperty(String property)
                 throws InvalidAttributeValueException
Deprecated. 

Sets the value of the Property attribute.

Parameters:
property - The new property value
Throws:
InvalidAttributeValueException
See Also:
JMSDestinationKeyMBean.getProperty()
This method can NOT set a null value.
This method can NOT set a value of zero length.

getKeyType

String getKeyType()
Deprecated. 

The expected sort key type for this JMS destination key. (This field is ignored for message header field keys, which have an implied type.)

Returns:
The keyType value

setKeyType

void setKeyType(String type)
                throws InvalidAttributeValueException
Deprecated. 

Sets the value of the KeyType attribute.

Parameters:
type - The new keyType value
Throws:
InvalidAttributeValueException
See Also:
JMSDestinationKeyMBean.getKeyType()
Default Value:
JMSConstants.KEY_TYPE_STRING
Valid Values:
JMSConstants.KEY_TYPE_BOOLEAN,JMSConstants.KEY_TYPE_BYTE,JMSConstants.KEY_TYPE_SHORT,JMSConstants.KEY_TYPE_INT,JMSConstants.KEY_TYPE_LONG,JMSConstants.KEY_TYPE_FLOAT,JMSConstants.KEY_TYPE_DOUBLE,JMSConstants.KEY_TYPE_STRING

getDirection

String getDirection()
Deprecated. 

The direction (Ascending or Descending) in which this key will sort messages. Select Ascending for a FIFO (first in, first out) sort order. Select Descending for a LIFO (last in, first out) sort order.

Note: This attribute is not dynamically configurable.

Returns:
The direction value

setDirection

void setDirection(String direction)
                  throws InvalidAttributeValueException
Deprecated. 

Sets the value of the Direction attribute.

Parameters:
direction - The new direction value
Throws:
InvalidAttributeValueException
See Also:
JMSDestinationKeyMBean.getDirection()
Default Value:
JMSConstants.KEY_DIRECTION_ASCENDING
Valid Values:
JMSConstants.KEY_DIRECTION_ASCENDING,JMSConstants.KEY_DIRECTION_DESCENDING

Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06