javax.management.DynamicMBean
, javax.management.MBeanRegistration
, javax.management.NotificationBroadcaster
, RuntimeMBean
, WebLogicMBean
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.
Modifier and Type | Field | Description |
---|---|---|
static long |
DEFAULT_CURSOR_TIMEOUT |
The default timeout for opened cursors is 5 minutes.
|
Modifier and Type | Method | Description |
---|---|---|
void |
closeCursor(java.lang.String cursorName) |
Disposes of the cursor once the client has fetched all the
records.
|
int |
deleteDataRecords(long startTime,
long endTime,
java.lang.String queryString) |
Delete records within the specified time range that match the
specified query.
|
java.lang.Object[] |
fetch(java.lang.String cursorName) |
Fetches a maximum of 100 items from the specified cursor.
|
java.lang.Object[] |
fetch(java.lang.String cursorName,
int maxItems) |
Fetches items from the open cursor.
|
java.util.Map |
getColumnIndexMap() |
Diagnostic data is logically organized as tabular data.
|
java.util.Map |
getColumnTypeMap() |
Diagnostic data is logically organized as tabular data.
|
int |
getDataRecordCount(long startRecordId,
long endRecordId,
long endTime,
java.lang.String query) |
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.
|
int |
getDataRecordCount(long startTime,
long endTime,
java.lang.String query) |
The number of records that match the specified query and time
range.
|
int |
getDataRecordCount(java.lang.String query) |
The number of records that match the specified query.
|
long |
getEarliestAvailableTimestamp() |
The timestamp, in milliseconds, since Jan 1, 1970 AD, 00:00:00
GMT for the earliest record in the diagnostic data log.
|
long |
getLatestAvailableTimestamp() |
The timestamp, in milliseconds, since Jan 1, 1970 AD, 00:00:00
GMT for the newest record in the diagnostic data log.
|
long |
getLatestRecordId() |
The latest known record ID for the underlying archive.
|
boolean |
hasMoreData(java.lang.String cursorName) |
Determines whether the specified cursor has more data to be
fetched.
|
boolean |
isTimestampAvailable() |
Returns true, if timestamp information is available with the underlying archive.
|
java.lang.String |
openCursor(long beginRecordId,
long endRecordId,
long endTimestamp,
java.lang.String query) |
Opens a cursor with a given query and a record-id range.
|
java.lang.String |
openCursor(long beginRecordId,
long endRecordId,
long endTimestamp,
java.lang.String query,
long cusorTimeout) |
Opens a cursor using the specified record-ID range, end
timestamp, and query.
|
java.lang.String |
openCursor(long beginTimestamp,
long endTimestamp,
java.lang.String query) |
Opens a cursor with the specified query and time range.
|
java.lang.String |
openCursor(long beginTimestamp,
long endTimestamp,
java.lang.String query,
long cusorTimeout) |
Opens a cursor for records that meet the specified time range
and query condition.
|
java.lang.String |
openCursor(java.lang.String query) |
Opens a cursor on the server side for the query.
|
java.lang.String |
openCursor(java.lang.String query,
long cursorTimeout) |
Opens a cursor with the specified timeout value, in
milliseconds.
|
getAttribute, getAttributes, invoke, setAttribute, setAttributes
postDeregister, postRegister, preRegister
addNotificationListener, getNotificationInfo, removeNotificationListener
addPropertyChangeListener, removePropertyChangeListener
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
static final long DEFAULT_CURSOR_TIMEOUT
The default timeout for opened cursors is 5 minutes.
java.lang.String openCursor(java.lang.String query) throws ManagementException
Opens a cursor on the server side for the query.
query
- The query expression to filter the result set from the
underlying diagnostic log.ManagementException
java.lang.String openCursor(java.lang.String query, long cursorTimeout) throws ManagementException
Opens a cursor with the specified timeout value, in milliseconds.
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.ManagementException
java.lang.String openCursor(long beginTimestamp, long endTimestamp, java.lang.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.
beginTimestamp
- endTimestamp
- query
- ManagementException
java.lang.String openCursor(long beginTimestamp, long endTimestamp, java.lang.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.
beginTimestamp
- endTimestamp
- query
- cusorTimeout
- ManagementException
java.lang.String openCursor(long beginRecordId, long endRecordId, long endTimestamp, java.lang.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.
beginRecordId
- Record id of the first record (inclusive) in the result setendRecordId
- Record id of the last record (exclusive) in the result setendTimestamp
- Include only those records whose timestamp is earlier than this valuequery
- Query criterionManagementException
java.lang.String openCursor(long beginRecordId, long endRecordId, long endTimestamp, java.lang.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.
beginRecordId
- Record id of the first record (inclusive) in the result setendRecordId
- Record id of the last record (exclusive) in the result setendTimestamp
- Include only those records whose timestamp is earlier than this valuequery
- Query criterioncusorTimeout
- ManagementException
int getDataRecordCount(java.lang.String query) throws ManagementException
The number of records that match the specified query.
query
- Query expressionManagementException
int getDataRecordCount(long startTime, long endTime, java.lang.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.
startTime
- Start time of the interval (inclusive)endTime
- End time of the interval (exclusive)query
- Query criterionManagementException
int getDataRecordCount(long startRecordId, long endRecordId, long endTime, java.lang.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.
startRecordId
- Record id of the first recordendRecordId
- Look at records whose record-ids are smaller than specified endrecordIdendTime
- Look at records which were entered prior to endTimequery
- Query criterionManagementException
boolean hasMoreData(java.lang.String cursorName) throws ManagementException
Determines whether the specified cursor has more data to be fetched.
cursorName
- true
if the given cursor has more data to be
fetched, false
otherwiseManagementException
java.lang.Object[] fetch(java.lang.String cursorName) throws ManagementException
Fetches a maximum of 100 items from the specified cursor.
cursorName
- ManagementException
java.lang.Object[] fetch(java.lang.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.
cursorName
- maxItems
- ManagementException
void closeCursor(java.lang.String cursorName) throws ManagementException
Disposes of the cursor once the client has fetched all the records.
cursorName
- ManagementException
java.util.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.
ManagementException
java.util.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.
ManagementException
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.
-1
if there are no records or the timestamp information is not available.ManagementException
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.
-1
if
the timestamp information is not available in the log.ManagementException
int deleteDataRecords(long startTime, long endTime, java.lang.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.
startTime
- Start time of the interval (inclusive)endTime
- End time of the interval (exclusive)queryString
- Query criterionManagementException
long getLatestRecordId() throws ManagementException
The latest known record ID for the underlying archive.
ManagementException
boolean isTimestampAvailable() throws ManagementException
Returns true, if timestamp information is available with the underlying archive.
ManagementException