DestinationKeyBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Destination Key beans control the sorting criteria of JMS destinations

       
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.j2ee.descriptor.wl.DestinationKeyBean
Factory Methods
Additional Access Points In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:

    Attributes

    This section describes the following attributes:

    Id

    Return the unique identifier of this bean instance.

           
    Privileges Read only
    Typelong
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    KeyType

    The expected property type for this destination key.

    Gets the "key-type" element

           
    Privileges Read/Write
    Typejava.lang.String
    Default ValueString
    Legal Values
    • Boolean
    • Byte
    • Short
    • Int
    • Long
    • Float
    • Double
    • String

    Name

    The name of this entity, represented in XML as an attribute.

    Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.

    This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.

           
    Privileges Read/Write
    Typejava.lang.String

    Notes

    Optional information that you can include to describe this named JMS descriptor bean.

    JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

    Note:

    If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

           
    Privileges Read/Write
    Typejava.lang.String

    Property

    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:

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

           
    Privileges Read/Write
    Typejava.lang.String
    Default ValueJMSMessageID

    SortOrder

    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.

           
    Privileges Read/Write
    Typejava.lang.String
    Default ValueAscending
    Legal Values
    • Ascending
    • Descending

    Operations

    This section describes the following operations:

      isSet

      Return true if the given property has been explicitly set in this bean.

         
      Operation Name"isSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to check
      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if propertyName is not a recognized property

      unSet

      Restore the given property to its default value.

         
      Operation Name"unSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to restore
      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • java.lang.IllegalArgumentException
        UnsupportedOperationException if called on a runtime implementation.