weblogic.j2ee.descriptor.wl
Interface DestinationKeyBean

All Superinterfaces:

NamedEntityBean, SettableBean

public interface DestinationKeyBean
extends NamedEntityBean

Destination Key beans control the sorting criteria of JMS destinations

Access limited to the following security roles:

Deployer

getProperty

String getProperty()

Specifies a message property name or the name of a message header field on which to sort messages. Message header field keys ignore the key type and reference message header fields rather than message properties.

Note: 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
• JMS_BEA_Size
• JMS_BEA_UnitOfOrder

This attribute is not dynamically configurable. Gets the "property" element

Returns:

The property value

Default Value:

"JMSMessageID"

setProperty

void setProperty(String property)
                 throws IllegalArgumentException

Specifies a message property name or the name of a message header field on which to sort messages. Message header field keys ignore the key type and reference message header fields rather than message properties.

Note: 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
• JMS_BEA_Size
• JMS_BEA_UnitOfOrder

This attribute is not dynamically configurable. Sets the "property" element

Parameters:

property - Sets the property to be used as a key

Throws:

IllegalArgumentException

getKeyType

String getKeyType()

The expected property type for this destination key.

Gets the "key-type" element

Returns:

The keyType value

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_TYPE_STRING

setKeyType

void setKeyType(String type)
                throws IllegalArgumentException

The expected property type for this destination key.

Sets the "key-type" element

Parameters:

type - The Java type of this property

Throws:

IllegalArgumentException

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_TYPE_BOOLEAN,weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_TYPE_BYTE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_TYPE_SHORT,weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_TYPE_INT,weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_TYPE_LONG,weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_TYPE_FLOAT,weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_TYPE_DOUBLE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_TYPE_STRING

getSortOrder

String getSortOrder()

The direction (Ascending or Descending) in which this key will sort messages.

Selecting the Ascending option for the JMSMessageID property implies a FIFO (first in, first out) sort order (the default for destinations). Select the Descending option for a LIFO (last in, first out) sort order.

This attribute is not dynamically configurable.

Gets the "sort-order" element

Returns:

The direction value

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_DIRECTION_ASCENDING

setSortOrder

void setSortOrder(String sortOrder)
                  throws IllegalArgumentException

The direction (Ascending or Descending) in which this key will sort messages.

Selecting the Ascending option for the JMSMessageID property implies a FIFO (first in, first out) sort order (the default for destinations). Select the Descending option for a LIFO (last in, first out) sort order.

This attribute is not dynamically configurable.

Sets the "sort-order" element

Parameters:

sortOrder - the sort-order this destination key should have

Throws:

IllegalArgumentException

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_DIRECTION_ASCENDING,weblogic.j2ee.descriptor.wl.constants.JMSConstants.KEY_DIRECTION_DESCENDING