|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SystemLogMBean
This interface provides various methods for getting system log information.
Method Summary | |
---|---|
String |
cleanALLogs(String aConfigId,
String aALName,
String[] logsToBeDeleted)
Deletes all the logs which are specified in " logsToBeDeleted " array. |
void |
cleanAllOldALLogs(Date aMinDate)
Deletes all AssemblyLines' log files older than the specified date. |
void |
cleanAllOldALLogs(Integer aKeepNum)
Deletes all AssemblyLines' log files except those generated on the " aKeepNum " latest runs of all AssemblyLines. |
void |
cleanAllOldLogs(Date aMinDate)
Deletes all log files older than the specified date. |
void |
cleanAllOldLogs(Integer aKeepNum)
Deletes all log files except those generated on the " aKeepNum " latest runs of all components. |
Boolean |
cleanOldALLogs(String aConfigId,
String aALName,
Date aMinDate)
Deletes those log files of the specified AssemblyLine, that are older than the specified date. |
Boolean |
cleanOldALLogs(String aConfigId,
String aALName,
Date aMinDate,
Date aMaxDate)
Deletes those log files of the specified AssemblyLine, that are older than the specified date. |
Boolean |
cleanOldALLogs(String aConfigId,
String aALName,
Integer aKeepNum)
Deletes all log files of the specified AssemblyLine except those generated on the " aKeepNum " latest AssemblyLine runs. |
String |
getALLastLogFileName(String aConfigId,
String aALName)
Returns the name of the log file created on the last run of a given AssemblyLine. |
String |
getALLog(String aConfigId,
String aALName,
String aLogFileName)
Given an AssemblyLine identification, and a log file name, retrieves the log of this AssemblyLine, stored in the specified file. |
String[] |
getALLogFileNames(String aConfigId,
String aALName)
Returns the names of all available log files for a given AssemblyLine. |
String[] |
getALLogFileNames(String aConfigId,
String aALName,
Date dDate)
Returns the names of all available log files prior to the specified 'date' for a given AssemblyLine. |
String[] |
getALLogFileNames(String aConfigId,
String aALName,
Date startDate,
Date endDate)
Returns the names of all available log files prior to the specified 'date' for a given AssemblyLine. |
String[] |
getALLogFileNames(String aConfigId,
String aALName,
int n)
Returns the names of all 'n' log files for a given AssemblyLine. |
String |
getALLogLastChunk(String aConfigId,
String aALName,
String aLogFileName,
Integer aKilobytes)
Retrieves the last chunk from a specified AssemblyLine's log file. |
Methods inherited from interface com.ibm.di.api.jmx.mbeans.BaseMBean |
---|
getId, getType |
Method Detail |
---|
String[] getALLogFileNames(String aConfigId, String aALName) throws DIException
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine.
DIException
- if an error occurs while obtaining AssemblyLine's log file
names.String[] getALLogFileNames(String aConfigId, String aALName, int n) throws DIException
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine.n
- the max number of log files to be returned. If n exceeds the
number of available log files then all the log files names are
returned.
DIException
- if an error occurs while obtaining AssemblyLine's log file
names.String[] getALLogFileNames(String aConfigId, String aALName, Date dDate) throws DIException
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine.dDate
- all the log files prior to this date will be listed.
DIException
- if an error occurs while obtaining AssemblyLine's log file
names.String[] getALLogFileNames(String aConfigId, String aALName, Date startDate, Date endDate) throws DIException
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine.startDate
- all the log files after this date will be listed.endDate
- all the log files before this date will be listed.
DIException
- if an error occurs while obtaining AssemblyLine's log file
names.String getALLastLogFileName(String aConfigId, String aALName) throws DIException
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine.
DIException
- if an error occurs while obtaining the log file name.String getALLog(String aConfigId, String aALName, String aLogFileName) throws DIException
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine.aLogFileName
- the name of the log file; no file path should be specified -
just the file name.
DIException
- if an error occurs while obtaining AssemblyLine's log.String getALLogLastChunk(String aConfigId, String aALName, String aLogFileName, Integer aKilobytes) throws DIException
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine.aLogFileName
- the name of the log file; no file path should be specified -
just the file name.aKilobytes
- specifies in kilobytes the size of the log's last chunk that
will be read.
DIException
- if an error occurs while obtaining AssemblyLine's log.void cleanAllOldLogs(Date aMinDate) throws DIException
aMinDate
- only log files that were last modified before this date will
be deleted.
DIException
- if an error occurs while deleting log files.void cleanAllOldLogs(Integer aKeepNum) throws DIException
aKeepNum
" latest runs of all components.
aKeepNum
- specifies the number of the latest log files that should not
be deleted; If for example, aKeepNum == 5
, for
each component only the 5 latest log files will not be
deleted.
DIException
- if an error occurs while deleting log files.void cleanAllOldALLogs(Date aMinDate) throws DIException
aMinDate
- only log files that were last modified before this date will
be deleted.
DIException
- if an error occurs while deleting log files.void cleanAllOldALLogs(Integer aKeepNum) throws DIException
aKeepNum
" latest runs of all AssemblyLines.
aKeepNum
- specifies the number of the latest log files that should not
be deleted; If for example, aKeepNum == 5
, for
each AssemblyLine only the 5 latest log files will not be
deleted.
DIException
- if an error occurs while deleting log files.Boolean cleanOldALLogs(String aConfigId, String aALName, Date aMinDate) throws DIException
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine whose logs will be cleaned up.aMinDate
- only log files that were last modified before this date will
be deleted.
Boolean
that holds true
if the
log files were deleted successfully; and null
if
there is no log folder for the specified AssemblyLine.
DIException
- if an error occurs while deleting log files.Boolean cleanOldALLogs(String aConfigId, String aALName, Date aMinDate, Date aMaxDate) throws DIException
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine whose logs will be cleaned up.aMinDate
- only log files that were last modified after this date will be
deleted.aMaxDate
- only log files that were last modified before this date will
be deleted.
Boolean
that holds true
if the
log files were deleted successfully; and null
if
there is no log folder for the specified AssemblyLine.
DIException
- if an error occurs while deleting log files.Boolean cleanOldALLogs(String aConfigId, String aALName, Integer aKeepNum) throws DIException
aKeepNum
" latest AssemblyLine runs.
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine whose logs will be cleaned up.aKeepNum
- specifies the number of the latest log files that should not
be deleted; If for example, aKeepNum == 5
only
the 5 latest AssemblyLine's log files will not be deleted.
Boolean
that holds true
if the
log files were deleted successfully; and null
if
there is no log folder for the specified AssemblyLine.
DIException
- if an error occurs while deleting log files.String cleanALLogs(String aConfigId, String aALName, String[] logsToBeDeleted) throws DIException
logsToBeDeleted
" array.
aConfigId
- identification of the AssemblyLine's Config Instance.aALName
- the name of the AssemblyLine whose logs will be cleaned up.logsToBeDeleted
- name of the log files which are to be deleted.
Boolean
that holds true
if the
log files were deleted successfully; and null
if
there is no log folder for the specified AssemblyLine.
DIException
- if an error occurs while deleting log files.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |