weblogic.management.configuration
Interface JMSDestinationKeyMBean

All Superinterfaces:

ConfigurationMBean, JMSConstants

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

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:

• JMSMessageID

• JMSTimestamp

• JMSCorrelationID

• JMSPriority

• JMSExpiration

• JMSType

• JMSRedelivered

• JMSDeliveryTime

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