com.sun.identity.log.handlers

Interface ReadDBHandler

All Known Implementing Classes:

LogReadDBHandler

public interface ReadDBHandler

DBReadHandler interface provides methods that must be present in each log read handler to read a log file. The LogReader knows only these methods and will call one of these as required.

Method Summary

Modifier and Type	Method and Description
String[][]	logRecRead(Set tableNames, LogQuery qry, LogManager logMgr, boolean sourceData) LogReader calls this method.
String[][]	logRecRead(String tableName, LogQuery qry, LogManager logMgr, boolean sourceData) LogReader calls this method.

Method Detail

logRecRead

String[][] logRecRead(String tableName,
                      LogQuery qry,
                      LogManager logMgr,
                      boolean sourceData)
               throws IOException,
                      NoSuchFieldException,
                      IllegalArgumentException,
                      RuntimeException,
                      SQLException,
                      Exception

LogReader calls this method. It collects header, records, applies query (if any), sorts (if asked) the records on field, checks the max records to return, collects all the recods and returns.

Parameters:

tableName - db table name

qry - is user specified qury chriteria with sorting requirement

logMgr - the log manager associated with this handler

sourceData - it specifies whether return data should be original data received by logger (source) or formatted data as in file.

Returns:

all the matched records with query

Throws:

IOException - if it fails to read log records.

NoSuchFieldException - if it fails to retrieve the name of field.

IllegalArgumentException - if query has wrong value.

RuntimeException - if it fails to retrieve log record.

SQLException - if it fails to process sql query.

Exception - if it fails any of operation.

logRecRead

String[][] logRecRead(Set tableNames,
                      LogQuery qry,
                      LogManager logMgr,
                      boolean sourceData)
               throws IOException,
                      NoSuchFieldException,
                      IllegalArgumentException,
                      RuntimeException,
                      SQLException,
                      Exception

LogReader calls this method. It collects header, records, applies query (if any), sorts (if asked) the records on field, checks the max records to return, collects all the recods and returns.

Parameters:

tableNames - db table names

qry - is user specified qury chriteria with sorting requirement

logMgr - the log manager associated with this handler

sourceData - it specifies whether return data should be original data received by logger (source) or formatted data as in file.

Returns:

all the matched records with query

Throws:

IOException - if it fails to read log records.

NoSuchFieldException - if it fails to retrieve the name of field.

IllegalArgumentException - if query has wrong value.

RuntimeException - if it fails to retrieve log record.

SQLException - if it fails to process sql query.

Exception - if it fails any of operation.