weblogic.diagnostics.accessor.runtime
Interface DataAccessRuntimeMBean

All Superinterfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

All Known Subinterfaces:

WLDFDataAccessRuntimeMBean

public interface DataAccessRuntimeMBean
extends RuntimeMBean

Use this interface to access the specific type of diagnostic data from an underlying log for which this instance is created.

Access limited to the following security roles:

Deployer, Monitor, Operator

DEFAULT_CURSOR_TIMEOUT

static final long DEFAULT_CURSOR_TIMEOUT

The default timeout for opened cursors is 5 minutes.

See Also:

Constant Field Values

openCursor

String openCursor(String query)
                  throws ManagementException

Opens a cursor on the server side for the query.

Parameters:

query - The query expression to filter the result set from the underlying diagnostic log.

Returns:

a handle to the open cursor on the server side with a default timeout of 5 minutes

Throws:

ManagementException

openCursor

String openCursor(String query,
                  long cursorTimeout)
                  throws ManagementException

Opens a cursor with the specified timeout value, in milliseconds.

Parameters:

query - The query expression to filter the result set from the underlying diagnostic log.

cursorTimeout - The timeout interval after which the cursor will become invalid if not invoked.

Returns:

a handle to the open cursor on the server side with a specified timeout value

Throws:

ManagementException

openCursor

String openCursor(long beginTimestamp,
                  long endTimestamp,
                  String query)
                  throws ManagementException

Opens a cursor with the specified query and time range.

Timestamps are specified as the number of milliseconds elapsed since the epoch: Jan 1 1970 AD, 00:00:00 GMT.

The default cursor timeout period is 5 minutes.

Parameters:

beginTimestamp -

endTimestamp -

query -

Throws:

ManagementException

openCursor

String openCursor(long beginTimestamp,
                  long endTimestamp,
                  String query,
                  long cusorTimeout)
                  throws ManagementException

Opens a cursor for records that meet the specified time range and query condition. The timeout value for the cursor is also specified.

Timestamps are specified as the number of milliseconds elapsed since the epoch: Jan 1 1970 AD, 00:00:00 GMT.

Parameters:

beginTimestamp -

endTimestamp -

query -

cusorTimeout -

Throws:

ManagementException

openCursor

String openCursor(long beginRecordId,
                  long endRecordId,
                  long endTimestamp,
                  String query)
                  throws ManagementException

Opens a cursor with a given query and a record-id range.

The timestamp is specified as the number of milliseconds elapsed since the epoch: Jan 1 1970 AD, 00:00:00 GMT.

The default cursor timeout period is 5 minutes.

Parameters:

beginRecordId - Record id of the first record (inclusive) in the result set

endRecordId - Record id of the last record (exclusive) in the result set

endTimestamp - Include only those records whose timestamp is earlier than this value

query - Query criterion

Throws:

ManagementException

openCursor

String openCursor(long beginRecordId,
                  long endRecordId,
                  long endTimestamp,
                  String query,
                  long cusorTimeout)
                  throws ManagementException

Opens a cursor using the specified record-ID range, end timestamp, and query. The timeout value for the cursor is also specified.

The timestamp is specified as the number of milliseconds elapsed since the epoch: Jan 1 1970 AD, 00:00:00 GMT.

Parameters:

beginRecordId - Record id of the first record (inclusive) in the result set

endRecordId - Record id of the last record (exclusive) in the result set

endTimestamp - Include only those records whose timestamp is earlier than this value

query - Query criterion

cusorTimeout -

Throws:

ManagementException

getDataRecordCount

int getDataRecordCount(String query)
                       throws ManagementException

The number of records that match the specified query.

Parameters:

query - Query expression

Returns:

Number of records that match specified query

Throws:

ManagementException

getDataRecordCount

int getDataRecordCount(long startTime,
                       long endTime,
                       String query)
                       throws ManagementException

The number of records that match the specified query and time range.

Start and end times are specified as the number of milliseconds elapsed since the epoch: Jan 1 1970 AD, 00:00:00 GMT.

Parameters:

startTime - Start time of the interval (inclusive)

endTime - End time of the interval (exclusive)

query - Query criterion

Returns:

Number of records which would match specified query and which are within specified time interval

Throws:

ManagementException

getDataRecordCount

int getDataRecordCount(long startRecordId,
                       long endRecordId,
                       long endTime,
                       String query)
                       throws ManagementException

The number that match the specified query and record-ID range, and whose timestamp (if it is available) is earlier than the specified end time.

The end time is specified as the number of milliseconds elapsed since the epoch: Jan 1 1970 AD, 00:00:00 GMT.

Parameters:

startRecordId - Record id of the first record

endRecordId - Look at records whose record-ids are smaller than specified endrecordId

endTime - Look at records which were entered prior to endTime

query - Query criterion

Returns:

Number of records which would match specified query and which are within specified record-id interval

Throws:

ManagementException

hasMoreData

boolean hasMoreData(String cursorName)
                    throws ManagementException

Determines whether the specified cursor has more data to be fetched.

Parameters:

cursorName -

Returns:

true if the given cursor has more data to be fetched, false otherwise

Throws:

ManagementException

fetch

Object[] fetch(String cursorName)
               throws ManagementException

Fetches a maximum of 100 items from the specified cursor.

Parameters:

cursorName -

Returns:

the items fetched

Throws:

ManagementException

fetch

Object[] fetch(String cursorName,
               int maxItems)
               throws ManagementException

Fetches items from the open cursor. The total number fetched is limited by the value of the maxItems parameter.

Parameters:

cursorName -

maxItems -

Returns:

the items fetched from the open cursor, up the number specified in the maxItems parameter

Throws:

ManagementException

closeCursor

void closeCursor(String cursorName)
                 throws ManagementException

Disposes of the cursor once the client has fetched all the records.

Parameters:

cursorName -

Throws:

ManagementException

getColumnTypeMap

Map getColumnTypeMap()
                     throws ManagementException

Diagnostic data is logically organized as tabular data. This method returns a map of column names to their type names, which are fully qualified class names for the primitive types Integer, Long, Float, Double, String, or an Object.

Returns:

a map of String column names to their types

Throws:

ManagementException

getColumnIndexMap

Map getColumnIndexMap()
                      throws ManagementException

Diagnostic data is logically organized as tabular data. This method returns a map of column names to their indices, which are represented as Integer objects.

Returns:

a map of String column names to their inidices

Throws:

ManagementException

getEarliestAvailableTimestamp

long getEarliestAvailableTimestamp()
                                   throws ManagementException

The timestamp, in milliseconds, since Jan 1, 1970 AD, 00:00:00 GMT for the earliest record in the diagnostic data log.

Returns:

The timestamp of the earliest record in the log or -1 if there are no records or the timestamp information is not available.

Throws:

ManagementException

getLatestAvailableTimestamp

long getLatestAvailableTimestamp()
                                 throws ManagementException

The timestamp, in milliseconds, since Jan 1, 1970 AD, 00:00:00 GMT for the newest record in the diagnostic data log.

Returns:

The timestamp of the newest record or -1 if the timestamp information is not available in the log.

Throws:

ManagementException

deleteDataRecords

int deleteDataRecords(long startTime,
                      long endTime,
                      String queryString)
                      throws ManagementException

Delete records within the specified time range that match the specified query. If the query is null or empty, all records within the time range will be deleted.

Start and end times are specified as the number of milliseconds elapsed since the epoch: Jan 1 1970 AD, 00:00:00 GMT.

Not all archives support a deletion feature. If not supported, this method will throw an UnsupportedOperationException exception.

Parameters:

startTime - Start time of the interval (inclusive)

endTime - End time of the interval (exclusive)

queryString - Query criterion

Returns:

Number of records deleted from the archive

Throws:

ManagementException

getLatestRecordId

long getLatestRecordId()
                       throws ManagementException

The latest known record ID for the underlying archive.

Throws:

ManagementException

isTimestampAvailable

boolean isTimestampAvailable()
                             throws ManagementException

Returns true, if timestamp information is available with the underlying archive.

Returns:

True, if underlying archive has record timestamp information

Throws:

ManagementException