com.ibm.di.api.remote
Interface SystemLog

All Superinterfaces:

Remote

All Known Implementing Classes:

SystemLogImpl

public interface SystemLog
extends Remote

This interface provides various methods for getting system log information.

Method Summary

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	cleanAllOldEHLogs(Date aMinDate) Deletes all EventHandlers' log files older than the specified date.
void	cleanAllOldEHLogs(int aKeepNum) Deletes all EventHandlers' log files except those generated on the "aKeepNum" latest runs of all EventHandlers.
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, int aKeepNum) Deletes all log files of the specified AssemblyLine except those generated on the "aKeepNum" latest AssemblyLine runs.
Boolean	cleanOldEHLogs(String aConfigId, String aEHName, Date aMinDate) Deletes those log files of the specified EventHandler, that are older than the specified date.
Boolean	cleanOldEHLogs(String aConfigId, String aEHName, int aKeepNum) Deletes all log files of the specified EventHandler except those generated on the "aKeepNum" latest EventHandler 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	getALLogLastChunk(String aConfigId, String aALName, String aLogFileName, int aKilobytes) Retrieves the last chunk from a specified AssemblyLine's log file.
String	getEHLastLogFileName(String aConfigId, String aEHName) Returns the name of the log file created on the last run of a given EventHandler.
String	getEHLog(String aConfigId, String aEHName, String aLogFileName) Given an EventHandler identification, and a log file name, retrieves the log of this EventHandler, stored in the specified file.
String[]	getEHLogFileNames(String aConfigId, String aEHName) Rreturns the names of all available log files for a given EventHandler.
String	getEHLogLastChunk(String aConfigId, String aEHName, String aLogFileName, int aKilobytes) Retrieves the last chunk from a specified EventHandler's log file.

Method Detail

getALLogFileNames

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

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.

RemoteException - if a communication-related exception occurs.

getALLastLogFileName

String getALLastLogFileName(String aConfigId,
                            String aALName)
                            throws DIException,
                                   RemoteException

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.

RemoteException - if a communication-related exception occurs.

getALLog

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

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 sepcified log of the AssemblyLine.

Throws:

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

RemoteException - if a communication-related exception occurs.

getALLogLastChunk

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

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.

RemoteException - if a communication-related exception occurs.

getEHLogFileNames

String[] getEHLogFileNames(String aConfigId,
                           String aEHName)
                           throws DIException,
                                  RemoteException

Rreturns the names of all available log files for a given EventHandler.

Parameters:

aConfigId - identification of the EventHandelr's Config Instance.

aEHName - the name of the EventHandler.

Returns:

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

Throws:

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

RemoteException - if a communication-related exception occurs.

getEHLastLogFileName

String getEHLastLogFileName(String aConfigId,
                            String aEHName)
                            throws DIException,
                                   RemoteException

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

Parameters:

aConfigId - identification of the EventHandelr's Config Instance.

aEHName - the name of the EventHandler.

Returns:

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

Throws:

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

RemoteException - if a communication-related exception occurs.

getEHLog

String getEHLog(String aConfigId,
                String aEHName,
                String aLogFileName)
                throws DIException,
                       RemoteException

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

Parameters:

aConfigId - identification of the EventHandelr's Config Instance.

aEHName - the name of the EventHandler.

aLogFileName - the name of the log file; no file path should be specified - just the file name.

Returns:

the specified log of the EventHandler.

Throws:

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

RemoteException - if a communication-related exception occurs.

getEHLogLastChunk

String getEHLogLastChunk(String aConfigId,
                         String aEHName,
                         String aLogFileName,
                         int aKilobytes)
                         throws DIException,
                                RemoteException

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

Parameters:

aConfigId - identification of the EventHandelr's Config Instance.

aEHName - the name of the EventHandler.

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 EventHandler's log.

Throws:

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

RemoteException - if a communication-related exception occurs.

cleanAllOldLogs

void cleanAllOldLogs(Date aMinDate)
                     throws DIException,
                            RemoteException

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.

RemoteException - if a communication-related exception occurs.

cleanAllOldLogs

void cleanAllOldLogs(int aKeepNum)
                     throws DIException,
                            RemoteException

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.

RemoteException - if a communication-related exception occurs.

cleanAllOldALLogs

void cleanAllOldALLogs(Date aMinDate)
                       throws DIException,
                              RemoteException

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.

RemoteException - if a communication-related exception occurs.

cleanAllOldALLogs

void cleanAllOldALLogs(int aKeepNum)
                       throws DIException,
                              RemoteException

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.

RemoteException - if a communication-related exception occurs.

cleanAllOldEHLogs

void cleanAllOldEHLogs(Date aMinDate)
                       throws DIException,
                              RemoteException

Deletes all EventHandlers' 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.

RemoteException - if a communication-related exception occurs.

cleanAllOldEHLogs

void cleanAllOldEHLogs(int aKeepNum)
                       throws DIException,
                              RemoteException

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

Parameters:

aKeepNum - specifies the number of the latest log files that should not be deleted; If for example, aKeepNum == 5, for each EventHandler only the 5 latest log files will not be deleted.

Throws:

DIException - if an error occurs while deleting log files.

RemoteException - if a communication-related exception occurs.

cleanOldALLogs

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

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.

RemoteException - if a communication-related exception occurs.

cleanOldALLogs

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

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.

RemoteException - if a communication-related exception occurs.

cleanOldEHLogs

Boolean cleanOldEHLogs(String aConfigId,
                       String aEHName,
                       Date aMinDate)
                       throws DIException,
                              RemoteException

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

Parameters:

aConfigId - identification of the EventHandler's Config Instance.

aEHName - the name of the EventHandler 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 EventHandler.

Throws:

DIException - if an error occurs while deleting log files.

RemoteException - if a communication-related exception occurs.

cleanOldEHLogs

Boolean cleanOldEHLogs(String aConfigId,
                       String aEHName,
                       int aKeepNum)
                       throws DIException,
                              RemoteException

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

Parameters:

aConfigId - identification of the EventHandler's Config Instance.

aEHName - the name of the EventHandler 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 EventHandler'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 EventHandler.

Throws:

DIException - if an error occurs while deleting log files.

RemoteException - if a communication-related exception occurs.