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.
Deprecated.
Security roles | The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
|
||
Fully Qualified Interface Name | If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.JMSDestinationKeyMBean
|
||
Factory Methods | |||
Deprecated Factory Methods and Access Points |
|
This section describes the following attributes:
Private property that disables caching in proxies.
This attribute is not dynamic and requires a server restart to take effect.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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.
Privileges | Read/Write |
Type | java.lang.String |
Default Value | Ascending |
Legal Values |
|
Return whether the MBean was created dynamically or is persisted to config.xml
This attribute is not dynamic and requires a server restart to take effect.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return the unique id of this MBean instance
This attribute is not dynamic and requires a server restart to take effect.
Privileges | Read only |
Type | long |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The expected sort key type for this JMS destination key. (This field is ignored for message header field keys, which have an implied type.)
Privileges | Read/Write |
Type | java.lang.String |
Default Value | String |
Legal Values |
|
Returns the MBean info for this MBean.
This attribute is not dynamic and requires a server restart to take effect.
Deprecated.
Privileges | Read only |
Type | javax.management.MBeanInfo |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The user-specified name of this MBean instance.
This name is included as one of the key properties in the
MBean's javax.management.ObjectName
:
Name=user-specified-name
This attribute is not dynamic and requires a server restart to take effect.
Privileges | Read/Write |
Type | java.lang.String |
Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration
file (config.xml
) as XML PCDATA. All left angle
brackets (<) are converted to the XML entity
<
. 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.
This attribute is not dynamic and requires a server restart to take effect.
Privileges | Read/Write |
Security roles | Write access is granted only to the following roles:
|
Type | java.lang.String |
Returns the ObjectName under which this MBean is registered in the MBean server.
This attribute is not dynamic and requires a server restart to take effect.
Deprecated.
Privileges | Read only |
Type | weblogic.management.WebLogicObjectName |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return the immediate parent for this MBean
This attribute is not dynamic and requires a server restart to take effect.
Privileges | Read/Write |
Type |
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.
Privileges | Read/Write |
Type | java.lang.String |
Returns false if the MBean represented by this object has been unregistered.
This attribute is not dynamic and requires a server restart to take effect.
Deprecated.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return all tags on this Configuration MBean
This attribute is dynamic and takes effect immediately.
Available Since | Release 12.2.1.0.0 |
Privileges | Read/Write |
Type | class java.lang.String[] |
Returns the type of the MBean.
This attribute is not dynamic and requires a server restart to take effect.
Privileges | Read only |
Type | java.lang.String |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.
Operation Name | "addTag" |
Parameters | Object [] { tag }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Exceptions |
|
If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.
Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.
Note: To insure that you are freezing the default value, invoke
the restoreDefaultValue
operation before you invoke
this.
This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.
Deprecated.
Operation Name | "freezeCurrentValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.
Operation Name | "getInheritedProperties" |
Parameters | Object [] { propertyNames }
where:
|
Signature | String [] {
"[Ljava.lang.String;" } |
Returns |
class |
Check if the value of a property is inherited from template mbean or not.
Operation Name | "isInherited" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Returns true if the specified attribute has been set explicitly in this MBean instance.
Operation Name | "isSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Remove a tag from this Configuration MBean
Operation Name | "removeTag" |
Parameters | Object [] { tag }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Exceptions |
|
If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.
Default values are subject to change if you update to a newer
release of WebLogic Server. To prevent the value from changing if
you update to a newer release, invoke the
freezeCurrentValue
operation.
This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.
Deprecated.
Operation Name | "restoreDefaultValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Restore the given property to its default value.
Operation Name | "unSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|