|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.log.LogReader
public class LogReader
LogReader class provides mechanism to read a log file to the caller. It does the authorization check, reads line from the file, applies the query (if any), collects most recent records, sorts the records, and returns the result in a two dimensional String. Where columns in the the first row, i.e. 0th row, always holds the header info (field names) present in the ELF formatted file. Other rows hold the value present under those columns.
Method Summary | |
---|---|
static ArrayList |
getLogFields()
Returns the names of the Log Fields that are selected for logging in the Logging Service template, plus the mandatory "time" and "Data" fields. |
static Set |
getLogNames()
Returns the names of the Log Files or Tables. |
static long |
getSize(String logName)
Returns the number of LogRecords in the specified table in the DB. |
static int |
getSizeUnits()
Returns the units (LogConstants.NUM_BYTES or LogConstants.NUM_RECORDS) that applies to the value returned by getSize(logName). |
static boolean |
isLogSecure()
|
static String[][] |
read(Set fileNames,
LogQuery logQuery,
Object userCrdential)
Retrieves specific records in a given sorted order on specific field (if user specifies valid sorting by field). |
static String[][] |
read(String fileName,
LogQuery logQuery,
Object userCrdential)
Retrieves specific records in a given sorted order on specific field (if user specifies valid sorting by field). |
static String[][] |
read(String fileName,
Object userCrdential)
Reads the specified log file provided the user has the authorization. |
static String[][] |
read(String logName,
String logType,
LogQuery logQuery,
Object userCrdential)
Retrieves records from log file provided it has the required authorization. |
static String[][] |
read(String logName,
String logType,
Object userCrdential)
Retrieves records from a log file provided the user has the required authorization. |
static String[][] |
read(String logname,
String logtype,
String timeStamp,
LogQuery logQuery,
Object userCrdential)
Reads a log file provided it has the required authorization. |
static String[][] |
read(String logName,
String logType,
String timeStamp,
Object userCrdential)
Reads a log file provided the user has the authorization. |
Method Detail |
---|
public static int getSizeUnits()
Exception
- if unrecoverable problem occurs, that is beyond
its control.public static long getSize(String logName)
logName
- the name of the Table or File.
IOException
- if file does not exist.
Exception
- if unrecoverable problem occurs, that is beyond
its control.public static Set getLogNames()
public static ArrayList getLogFields()
public static String[][] read(String fileName, Object userCrdential)
fileName
- the filename without path to be read.userCrdential
- user credential to check authorization.
IOException
- if interrupted or failed to do I/O.
NoSuchFieldException
- if invalid field has been specified.
IllegalArgumentException
- when inappropriate argument specified.
RuntimeException
- when it has been caught in any phase.
Exception
- if unrecoverable problem occurs, that is beyond
its control.public static String[][] read(String logName, String logType, Object userCrdential)
logname
and
type
.
It reads all records from the file but returns the maximum number
of most recent records set through configuration.
logName
- an identifier and is a part of file name to be read.logType
- the components of file name that will be read. it could
be either of "access", "error" or "system".userCrdential
- user credential to check authorization.
IOException
- if interrupted or failed to do I/O.
NoSuchFieldException
- if invalid field has been specified.
IllegalArgumentException
- when inappropriate argument specified.
RuntimeException
- when it has been caught in any phase.
Exception
- if unrecoverable problem occurs, that is beyond
its control.public static String[][] read(String logName, String logType, String timeStamp, Object userCrdential)
logName
- an identifier and is a part of file name to be read.logType
- the components of filename to be read, not null.timeStamp
- last component of filename to be read and not null.userCrdential
- user credential for authorization check.
IOException
- if interrupted or failed to do I/O.
NoSuchFieldException
- if invalid field has been specified.
IllegalArgumentException
- when inappropriate argument specified.
RuntimeException
- when it has been caught in any phase.
Exception
- if unrecoverable problem occurs, that is beyond
its control.public static String[][] read(String logName, String logType, LogQuery logQuery, Object userCrdential)
logName
- an identifier and is a part of file name to be read.logType
- the components of filename to be read.logQuery
- contains search criteria details.userCrdential
- user credential for authorization check.
IOException
- if interrupted or failed to do I/O.
NoSuchFieldException
- if invalid field has been specified.
IllegalArgumentException
- when inappropriate argument specified.
RuntimeException
- when it has been caught in any phase.
Exception
- if unrecoverable problem occurs, that is beyond
its control.public static String[][] read(String logname, String logtype, String timeStamp, LogQuery logQuery, Object userCrdential)
logname
- an identifier and is a part of file name to be read.logtype
- the components of filename to be read.timeStamp
- is the last component of filename to be read and not
null.logQuery
- contains search criteria details.userCrdential
- user credential for authorization check.
IOException
- if interrupted or failed to do I/O.
NoSuchFieldException
- if invalid field has been specified.
IllegalArgumentException
- when inappropriate argument specified.
RuntimeException
- when it has been caught in any phase.
Exception
- if unrecoverable problem occurs, that is beyond
its control.public static String[][] read(String fileName, LogQuery logQuery, Object userCrdential)
fileName
- filename without path that will be read.logQuery
- contains search criteria details.userCrdential
- user credential for authorization check.
IOException
- if interrupted or failed to do I/O.
NoSuchFieldException
- if invalid field has been specified.
IllegalArgumentException
- when inappropriate argument specified.
RuntimeException
- when it has been caught in any phase.
Exception
- if unrecoverable problem occurs, that is beyond
its control.public static String[][] read(Set fileNames, LogQuery logQuery, Object userCrdential)
fileNames
- set of filenames without path that will be readlogQuery
- contains search criteria detailsuserCrdential
- user credential for authorization check.
IOException
- if interrupted or failed to do I/O.
NoSuchFieldException
- if invalid field has been specified.
IllegalArgumentException
- when inappropriate argument specified.
RuntimeException
- when it has been caught in any phase.
Exception
- if unrecoverable problem occurs, that is beyond
its control.public static boolean isLogSecure()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |