alma.acs.logging.tools

Class LogFileExtractor

java.lang.Object

alma.acs.logging.tools.LogFileExtractor

All Implemented Interfaces:

IOPorgressListener, ACSRemoteErrorListener, ACSRemoteLogListener

public class LogFileExtractor
extends java.lang.Object
implements ACSRemoteLogListener, ACSRemoteErrorListener, IOPorgressListener

An object to extract the logs that matches the given criteria. It reads the input file and parse each log and writes in the output all the logs matching the criteria. It is possible to specify a start and/or end date or pass the name of a filter to load. The filters are the same used by jlog so jlog can be used to edit and save such file.

Author:

acaproni

Constructor Summary

Constructors

Constructor and Description
LogFileExtractor(java.lang.String[] inputFiles, java.lang.String outputFile, java.util.Date startDate, java.util.Date endDate, java.lang.String filterName, LogConverter converter) Constructor The parameters defines the criteria.

Method Summary

Modifier and Type	Method and Description
void	bytesRead(long bytes) This method notifies about the number of bytes read during a load.
void	bytesWritten(long bytes) This method notifies about the total number of bytes written during a save.
void	errorReceived(java.lang.String xml) The method is executed when an error happened building a log from a string.
void	extract() Extract the logs from the source to the destination applying the selection criteria given in the constructor
void	logEntryReceived(ILogEntry logEntry) The method is executed when a new log arrives from the NC
void	logsRead(int numOfLogs) This method notifies about the total number of logs read during a load.
void	logsWritten(int numOfLogs) This method notifies about the total number of logs written during a save.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogFileExtractor

public LogFileExtractor(java.lang.String[] inputFiles,
                        java.lang.String outputFile,
                        java.util.Date startDate,
                        java.util.Date endDate,
                        java.lang.String filterName,
                        LogConverter converter)
                 throws java.lang.Exception

Constructor The parameters defines the criteria. They can be null (but not all null of course). All the criteria are applied in AND. If the start/end date are not present, the dates are not checked.

Parameters:

inputFiles - The name of the files of logs for input

outputFile - The name of the file with the selected logs

startDate - The start date of logs (can be null)

endDate - The end date of the logs (can be null)

filterName - The name of a file of filters to apply to select logs (can be null)

converter - The convert to save logs in different output formats

Throws:

Exception - In case of error

java.lang.Exception

Method Detail

extract

public void extract()
             throws java.lang.Exception

Extract the logs from the source to the destination applying the selection criteria given in the constructor

Throws:

java.lang.Exception

bytesRead

public void bytesRead(long bytes)

Description copied from interface: IOPorgressListener

This method notifies about the number of bytes read during a load.

The value passed as parameter represent the total number of bytes read since the beginning of the load and includes the bytes of the header

Specified by:

bytesRead in interface IOPorgressListener

Parameters:

bytes - The number of bytes read while loading

See Also:

IOPorgressListener.bytesRead(long)

bytesWritten

public void bytesWritten(long bytes)

Description copied from interface: IOPorgressListener

This method notifies about the total number of bytes written during a save.

The value passed as parameter includes the number of the bytes read since the beginning of the save.

Specified by:

bytesWritten in interface IOPorgressListener

Parameters:

bytes - The number of bytes read while loading

See Also:

IOPorgressListener.bytesWritten(long)

logsRead

public void logsRead(int numOfLogs)

Description copied from interface: IOPorgressListener

This method notifies about the total number of logs read during a load.

The value passed as parameter is the number of logs read since the beginning of the save.

Specified by:

logsRead in interface IOPorgressListener

See Also:

IOPorgressListener.logsRead(int)

logsWritten

public void logsWritten(int numOfLogs)

Description copied from interface: IOPorgressListener

This method notifies about the total number of logs written during a save.

The value passed as parameter is the number of logs written since the beginning of the save.

Specified by:

logsWritten in interface IOPorgressListener

See Also:

IOPorgressListener.logsWritten(int)

errorReceived

public void errorReceived(java.lang.String xml)

Description copied from interface: ACSRemoteErrorListener

The method is executed when an error happened building a log from a string. The parameter is the string that caused the error and it can be - the XML that was not possible to parse - a cache string if the binary format of logs is in use The cache string is a string used in the cache whose format might change with different implementation of of the cache.

Specified by:

errorReceived in interface ACSRemoteErrorListener

Parameters:

xml - That string that caused the error

logEntryReceived

public void logEntryReceived(ILogEntry logEntry)

Description copied from interface: ACSRemoteLogListener

The method is executed when a new log arrives from the NC

Specified by:

logEntryReceived in interface ACSRemoteLogListener

Parameters:

logEntry - The new log just read from the NC

See Also:

ACSRemoteLogListener.logEntryReceived(com.cosylab.logging.engine.log.ILogEntry)