alma.acs.logging.archive.zoom

Class FileHelper

java.lang.Object

alma.acs.logging.archive.zoom.FileHelper

All Implemented Interfaces:

ACSRemoteErrorListener

public class FileHelper
extends java.lang.Object
implements ACSRemoteErrorListener

An helper glass to get logs from a file..

The class read a file with the help of IOHelper and adds a filter for the start and end dates and another one for the levels.

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field and Description
long	endTime The end time of the logs to read from file
LogTypeHelper	maxLogLevel The max log level to read from the file (inclusive)
LogTypeHelper	minLogLevel The min log level to read from the file (inclusive)
long	startTime The start time of the logs to read from file (>=0)

Constructor Summary

Constructors

Constructor and Description
FileHelper(java.io.File inFile, long start, long end, LogTypeHelper lowLvl, LogTypeHelper hiLvl) Constructor

Method Summary

Modifier and Type	Method and Description
void	errorReceived(java.lang.String xml) The method is executed when an error happened building a log from a string.
boolean	loadLogs(ACSRemoteLogListener logListener, IOPorgressListener ioListener, ACSRemoteErrorListener errorListener) Load the logs for the file.
void	stopLoading() Stop loading logs.

Methods inherited from class java.lang.Object

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

Field Detail

minLogLevel

public final LogTypeHelper minLogLevel

The min log level to read from the file (inclusive)

maxLogLevel

public final LogTypeHelper maxLogLevel

The max log level to read from the file (inclusive)

startTime

public final long startTime

The start time of the logs to read from file (>=0)

endTime

public final long endTime

The end time of the logs to read from file

Constructor Detail

FileHelper

public FileHelper(java.io.File inFile,
                  long start,
                  long end,
                  LogTypeHelper lowLvl,
                  LogTypeHelper hiLvl)
           throws ZoomException

Constructor

Parameters:

inFile - The file to read logs from

start - The start time (>=0)

end - The ending time

lowlvl - The lowest log level to read (inclusive)

hiLvl - The highest level to read (inclusive)

Throws:

java.io.IOException - If the file is unreadable

ZoomException

Method Detail

loadLogs

public boolean loadLogs(ACSRemoteLogListener logListener,
                        IOPorgressListener ioListener,
                        ACSRemoteErrorListener errorListener)
                 throws ZoomException,
                        java.io.FileNotFoundException

Load the logs for the file.

This method return errors in two ways:

• with an exception when the error arise while setting up the file and the filters for loading while reading the file
• returning false in case of errors parsing logs read from file

The error listener passed as parameter can be null. In fact the error listener gets the strings of the logs that returned an error while parsing. If the caller is not interested in those strings but only to know if there were parsing errors then it will be enough for the caller to check the value of the returned boolean.

Parameters:

logListener - The listener of the logs read from the file

ioListener - The listener for the progress of loading

errorListener - The listener of errors parsing logs (can'be null)

Returns:

false in case of errors loading logs; true otherwise

Throws:

ZoomException - In case of errors creating filters

java.io.FileNotFoundException - If the file was not found

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

See Also:

ACSRemoteErrorListener.errorReceived(java.lang.String)

stopLoading

public void stopLoading()

Stop loading logs.

stopLoading does nothing if no load is in progress.