CursorRuntimeMBean (Java API Reference for Oracle WebLogic Server)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.runtime
Interface CursorRuntimeMBean

All Superinterfaces:: DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

All Known Subinterfaces:: JMSDestinationRuntimeMBean, JMSDurableSubscriberRuntimeMBean, JMSMessageCursorRuntimeMBean, JMSMessageManagementRuntimeMBean, JMSRemoteEndpointRuntimeMBean, JMSServerRuntimeMBean, MessageCursorRuntimeMBean, PSAssemblyRuntimeMBean, PSEntryCursorRuntimeMBean, SAFMessageCursorRuntimeMBean, SAFRemoteEndpointRuntimeMBean, WSRMRemoteEndpointRuntimeMBean

public interface CursorRuntimeMBean
extends RuntimeMBean
extends RuntimeMBean

This interface is a base interface for paging cursor implementations. It defines methods for manipulating a result set maintained on the server. Methods for accessing items in the result set return arrays of javax.management.openmbean.CompositeData objects. Each component that implements this interface is responsible for converting item objects to self-describing CompositeData objects. An instance of a cursor is represented by a handle.

See Also:: CompositeData

Method Summary
`Void`	`closeCursor(String cursorHandle)` Releases the server-side resources associated with the cursor and removes the runtime MBean instance.
`Long`	`getCursorEndPosition(String cursorHandle)` Returns the cursor end position in the result set.
`Long`	`getCursorSize(String cursorHandle)` Returns the number of items in the result set.
`Long`	`getCursorStartPosition(String cursorHandle)` Returns the cursor start position in the result set.
`CompositeData[]`	`getItems(String cursorHandle, Long start, Integer count)` Returns an array of items from the specified cursor location.
`CompositeData[]`	`getNext(String cursorHandle, Integer count)` Returns an array of items starting from the current cursor end position.
`CompositeData[]`	`getPrevious(String cursorHandle, Integer count)` Returns an array of items up to the current cursor start position.

Methods inherited from interface weblogic.management.WebLogicMBean
`getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent`

Methods inherited from interface javax.management.DynamicMBean
`getAttribute, getAttributes, invoke, setAttribute, setAttributes`

Methods inherited from interface javax.management.MBeanRegistration
`postDeregister, postRegister, preDeregister, preRegister`

Methods inherited from interface javax.management.NotificationBroadcaster
`addNotificationListener, getNotificationInfo, removeNotificationListener`

Method Detail

getCursorStartPosition

Long getCursorStartPosition(String cursorHandle)
                            throws ManagementException

Returns the cursor start position in the result set.

Parameters:: cursorHandle - The cursor handle.
Returns:: The cursor start position.
Throws:: ManagementException

getCursorEndPosition

Long getCursorEndPosition(String cursorHandle)
                          throws ManagementException

Returns the cursor end position in the result set.

Parameters:: cursorHandle - The cursor handle.
Returns:: The cursor end position.
Throws:: ManagementException

getItems

CompositeData[] getItems(String cursorHandle,
                         Long start,
                         Integer count)
                         throws 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.

Parameters:: cursorHandle - The cursor handle.; start - The new cursor start location.; count - The maximum number of items to return.
Returns:: An array of items in CompositeData representation.
Throws:: ManagementException
See Also:: CompositeData

getNext

CompositeData[] getNext(String cursorHandle,
                        Integer count)
                        throws 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.

Parameters:: cursorHandle - The cursor handle.; count - The maximum number of items to return.
Returns:: An array of items in CompositeData representation.
Throws:: ManagementException
See Also:: CompositeData

getPrevious

CompositeData[] getPrevious(String cursorHandle,
                            Integer count)
                            throws 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.

Parameters:: cursorHandle - The cursor handle.; count - The maximum number of item to return.
Returns:: An array of item info objects.
Throws:: ManagementException
See Also:: CompositeData

getCursorSize

Long getCursorSize(String cursorHandle)
                   throws ManagementException

Returns the number of items in the result set.

Parameters:: cursorHandle - The cursor handle.
Throws:: ManagementException

closeCursor

Void closeCursor(String cursorHandle)
                 throws ManagementException

Releases the server-side resources associated with the cursor and removes the runtime MBean instance.

Parameters:: cursorHandle - The cursor handle.
Throws:: ManagementException