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