This runtime MBean represents a handle to a server-side JMS message result set. It is used for paging through large sets of messages. Messages are returned in an array of CompositeData objects that contain the message header fields and additional attributes.
If you use the getMBeanInfo
operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.JMSMessageCursorRuntimeMBean
For more information, see:
Since 9.0.0.0
No factory methods. Instances of this MBean are created automatically.
The following MBeans extend or implement this MBean type:
This section describes the following attributes:
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Privileges | Read only |
Type | java.lang.String |
Return the immediate parent for this MBean
Privileges | Read/Write |
Type |
Returns the type of the MBean.
Privileges | Read only |
Type | java.lang.String |
This section describes the following operations:
Releases the server-side resources associated with the cursor and removes the runtime MBean instance.
Operation Name | "closeCursor" |
Parameters | Object [] {
cursorHandle }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns | Void
|
weblogic.management.ManagementException
Returns the cursor end position in the result set.
Operation Name | "getCursorEndPosition" |
Parameters | Object [] {
cursorHandle }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns | Long
|
weblogic.management.ManagementException
Returns the number of items in the result set.
Operation Name | "getCursorSize" |
Parameters | Object [] {
cursorHandle }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns | Long
|
weblogic.management.ManagementException
Returns the cursor start position in the result set.
Operation Name | "getCursorStartPosition" |
Parameters | Object [] {
cursorHandle }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns | Long
|
weblogic.management.ManagementException
Returns an array of items from the specified cursor location. The new cursor start position will be the location after the old cursor end position. The size of the array returned is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the return array is zero. In this case, the cursor position will not change.
For more information, see:
Operation Name | "getItems" |
Parameters | Object [] {
cursorHandle, start, count }
where:
|
Signature | String [] {
"java.lang.String",
"java.lang.Long",
"java.lang.Integer" } |
Returns |
class |
weblogic.management.ManagementException
Returns the message associated with the specified cursor handle.
For more information, see:
Operation Name | "getMessage" |
Parameters | Object [] {
cursorHandle, messageHandle }
where:
|
Signature | String [] {
"java.lang.String",
"java.lang.Long" } |
Returns | CompositeData |
weblogic.management.ManagementException
Given a JMS message ID this method returns the corresponding message from the queue. If no message with the specified message ID exists on the destination, a null value is returned.
For more information, see:
Operation Name | "getMessage" |
Parameters | Object [] {
cursorHandle, messageID }
where:
|
Signature | String [] {
"java.lang.String",
"java.lang.String" } |
Returns | CompositeData |
weblogic.management.ManagementException
Returns an array of items starting from the current cursor end position. The new cursor start position is set to be the location of the first item returned to the caller. The new cursor end position is set according to the size of the array returned, which is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the array is zero. In this case, the cursor position will not change.
For more information, see:
Operation Name | "getNext" |
Parameters | Object [] {
cursorHandle, count }
where:
|
Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
Returns |
class |
weblogic.management.ManagementException
Returns an array of items up to the current cursor start position. The new start position will be placed at the location of the first item in the set returned to the caller. The new cursor end position will be placed at the location after the last item in the set that is returned.
For more information, see:
Operation Name | "getPrevious" |
Parameters | Object [] {
cursorHandle, count }
where:
|
Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
Returns |
class |
weblogic.management.ManagementException
Sorts the entire message result set managed by the cursor according to the JMS header attributes specified. The cursor position is set to the new position of the message corresponding to the "start" location before the sort is performed. The method returns the new cursor position.
For more information, see:
Operation Name | "sort" |
Parameters | Object [] {
cursorHandle, start, fields, ascending }
where:
|
Signature | String [] {
"java.lang.String",
"java.lang.Long",
"[Ljava.lang.String;",
"[Ljava.lang.Boolean;" } |
Returns | Long
|
weblogic.management.ManagementException