com.ibm.di.api.local
Interface SystemLog

All Known Implementing Classes:

SystemLogImpl

public interface SystemLog

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(int 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(int 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, int 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 iNumber) Returns the names of first 'n' log files for a given AssemblyLine.
String	getALLogLastChunk(String aConfigId, String aALName, String aLogFileName, int aKilobytes) Retrieves the last chunk from a specified AssemblyLine's log file.

Method Detail

getALLogFileNames

String[] getALLogFileNames(String aConfigId,
                           String aALName)
                           throws DIException

Returns the names of all available log files for a given AssemblyLine.

Parameters:

aConfigId - identification of the AssemblyLine's Config Instance.

aALName - the name of the AssemblyLine.

Returns:

a String array, each of its elements specifying the name of a log file.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log file names.

getALLogFileNames

String[] getALLogFileNames(String aConfigId,
                           String aALName,
                           int iNumber)
                           throws DIException

Returns the names of first 'n' log files for a given AssemblyLine.

Parameters:

aConfigId - identification of the AssemblyLine's Config Instance.

aALName - the name of the AssemblyLine.

iNumber - the max number of log files to be returned. If iNumber exceeds the number of available log files then all the log files names are returned.

Returns:

a String array, each of its elements specifying the name of a log file.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log file names.

getALLogFileNames

String[] getALLogFileNames(String aConfigId,
                           String aALName,
                           Date dDate)
                           throws DIException

Returns the names of all available log files prior to the specified 'date' for a given AssemblyLine.

Parameters:

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.

Returns:

a String array, each of its elements specifying the name of a log file.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log file names.

getALLogFileNames

String[] getALLogFileNames(String aConfigId,
                           String aALName,
                           Date startDate,
                           Date endDate)
                           throws DIException

Returns the names of all available log files prior to the specified 'date' for a given AssemblyLine.

Parameters:

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.

Returns:

a String array, each of its elements specifying the name of a log file.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log file names.

getALLastLogFileName

String getALLastLogFileName(String aConfigId,
                            String aALName)
                            throws DIException

Returns the name of the log file created on the last run of a given AssemblyLine.

Parameters:

aConfigId - identification of the AssemblyLine's Config Instance.

aALName - the name of the AssemblyLine.

Returns:

the name of the log file created on the last AssemblyLine's run.

Throws:

DIException - if an error occurs while obtaining the log file name.

getALLog

String getALLog(String aConfigId,
                String aALName,
                String aLogFileName)
                throws DIException

Given an AssemblyLine identification, and a log file name, retrieves the log of this AssemblyLine, stored in the specified file.

Parameters:

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.

Returns:

the specified log of the AssemblyLine.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log.

getALLogLastChunk

String getALLogLastChunk(String aConfigId,
                         String aALName,
                         String aLogFileName,
                         int aKilobytes)
                         throws DIException

Retrieves the last chunk from a specified AssemblyLine's log file.

Parameters:

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.

Returns:

the last chunk of the specified AssemblyLine's log.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log.

cleanAllOldLogs

void cleanAllOldLogs(Date aMinDate)
                     throws DIException

Deletes all log files older than the specified date.

Parameters:

aMinDate - only log files that were last modified before this date will be deleted.

Throws:

DIException - if an error occurs while deleting log files.

cleanAllOldLogs

void cleanAllOldLogs(int aKeepNum)
                     throws DIException

Deletes all log files except those generated on the " aKeepNum" latest runs of all components.

Parameters:

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.

Throws:

DIException - if an error occurs while deleting log files.

cleanAllOldALLogs

void cleanAllOldALLogs(Date aMinDate)
                       throws DIException

Deletes all AssemblyLines' log files older than the specified date.

Parameters:

aMinDate - only log files that were last modified before this date will be deleted.

Throws:

DIException - if an error occurs while deleting log files.

cleanAllOldALLogs

void cleanAllOldALLogs(int aKeepNum)
                       throws DIException

Deletes all AssemblyLines' log files except those generated on the " aKeepNum" latest runs of all AssemblyLines.

Parameters:

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.

Throws:

DIException - if an error occurs while deleting log files.

cleanOldALLogs

Boolean cleanOldALLogs(String aConfigId,
                       String aALName,
                       Date aMinDate)
                       throws DIException

Deletes those log files of the specified AssemblyLine, that are older than the specified date.

Parameters:

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.

Returns:

a Boolean that holds true if the log files were deleted successfully; and null if there is no log folder for the specified AssemblyLine.

Throws:

DIException - if an error occurs while deleting log files.

cleanOldALLogs

Boolean cleanOldALLogs(String aConfigId,
                       String aALName,
                       Date aMinDate,
                       Date aMaxDate)
                       throws DIException

Deletes those log files of the specified AssemblyLine, that are older than the specified date.

Parameters:

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.

Returns:

a Boolean that holds true if the log files were deleted successfully; and null if there is no log folder for the specified AssemblyLine.

Throws:

DIException - if an error occurs while deleting log files.

cleanOldALLogs

Boolean cleanOldALLogs(String aConfigId,
                       String aALName,
                       int aKeepNum)
                       throws DIException

Deletes all log files of the specified AssemblyLine except those generated on the "aKeepNum" latest AssemblyLine runs.

Parameters:

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.

Returns:

a Boolean that holds true if the log files were deleted successfully; and null if there is no log folder for the specified AssemblyLine.

Throws:

DIException - if an error occurs while deleting log files.

cleanALLogs

String cleanALLogs(String aConfigId,
                   String aALName,
                   String[] logsToBeDeleted)
                   throws DIException

Deletes all the logs which are specified in " logsToBeDeleted" array.

Parameters:

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.

Returns:

a String that holds null if the log files are deleted successfully; else comma separated names of the log files which are not deleted.

Throws:

DIException - if an error occurs while deleting log files.