com.ibm.di.api.remote.impl
Class SystemLogImpl

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              com.ibm.di.api.remote.impl.SystemLogImpl

All Implemented Interfaces:

SystemLog, Serializable, Remote

public class SystemLogImpl
extends UnicastRemoteObject
implements SystemLog

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

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.
static SystemLogImpl	createInstance(SystemLog aLocalSystemLog, SessionImpl aSession)
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.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getALLogFileNames

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

Description copied from interface: SystemLog

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

Specified by:

getALLogFileNames in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

getALLastLogFileName in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

getALLog in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

getALLogLastChunk in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

getEHLogFileNames in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

getEHLastLogFileName in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

getEHLog in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

getEHLogLastChunk in interface SystemLog

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

public void cleanAllOldLogs(Date aMinDate)
                     throws DIException,
                            RemoteException

Description copied from interface: SystemLog

Deletes all log files older than the specified date.

Specified by:

cleanAllOldLogs in interface SystemLog

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

public void cleanAllOldLogs(int aKeepNum)
                     throws DIException,
                            RemoteException

Description copied from interface: SystemLog

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

Specified by:

cleanAllOldLogs in interface SystemLog

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

public void cleanAllOldALLogs(Date aMinDate)
                       throws DIException,
                              RemoteException

Description copied from interface: SystemLog

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

Specified by:

cleanAllOldALLogs in interface SystemLog

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

public void cleanAllOldALLogs(int aKeepNum)
                       throws DIException,
                              RemoteException

Description copied from interface: SystemLog

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

Specified by:

cleanAllOldALLogs in interface SystemLog

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

public void cleanAllOldEHLogs(Date aMinDate)
                       throws DIException,
                              RemoteException

Description copied from interface: SystemLog

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

Specified by:

cleanAllOldEHLogs in interface SystemLog

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

public void cleanAllOldEHLogs(int aKeepNum)
                       throws DIException,
                              RemoteException

Description copied from interface: SystemLog

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

Specified by:

cleanAllOldEHLogs in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

cleanOldALLogs in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

cleanOldALLogs in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

cleanOldEHLogs in interface SystemLog

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

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

Description copied from interface: SystemLog

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

Specified by:

cleanOldEHLogs in interface SystemLog

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.

createInstance

public static SystemLogImpl createInstance(SystemLog aLocalSystemLog,
                                           SessionImpl aSession)
                                    throws DIException,
                                           RemoteException

Throws:

DIException

RemoteException