alma.acs.logging.io

Class IOLogsHelper

java.lang.Object

alma.acs.logging.io.IOLogsHelper

All Implemented Interfaces:

IOPorgressListener

public class IOLogsHelper
extends java.lang.Object
implements IOPorgressListener

This class is intended to support the commons IO operations aiming to keep the LogTableDataModel class shorter and more readable.

This class instantiate a new thread for each load/save operation. To cleanly close, the done() must be called.

This class allows only one load/save at a time. If an I/O is requested while another one is in progress, an exception is thrown.

This class is not thread safe!

Author:

acaproni

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IOLogsHelper.LoadUrl A class to download logs from a remote URL.

Constructor Summary

Constructors

Constructor and Description
IOLogsHelper(LoggingClient client) Build an IOCacheHelper object

Method Summary

Modifier and Type	Method and Description
void	bytesRead(long bytes) Moves the progress bar of the progress monitor
void	bytesWritten(long bytes) This method notifies about the total number of bytes written during a save.
void	done(boolean sync) Release the resource acquired by this object It terminates the thread so the object can be deleted by the JVM NOTE: when the thread is terminated it is not possible to request asynchronous services
IOHelper	getIoHelper()
boolean	isPerformingIO() Check if a load/save is in progress
void	loadLogs(java.io.BufferedReader br, ACSRemoteLogListener logListener, ACSRemoteErrorListener errorListener, int progressRange) Load the logs from the given file in the Cache appending their starting positions in the index vector.
void	loadLogsFromUrl(java.net.URL url, ACSRemoteLogListener logListener, ACSRemoteErrorListener errorListener) Load logs from the passed url.
void	logsRead(int numOfLogs) Change the label of the progress monitor
void	logsWritten(int numOfLogs) This method notifies about the total number of logs written during a save.
void	saveLogs(java.lang.String fileName, boolean compress, int level, LogCache cache) Save the logs in a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

IOLogsHelper

public IOLogsHelper(LoggingClient client)
             throws java.lang.Exception

Build an IOCacheHelper object

Throws:

java.lang.Exception - IN case of error building the IOHelper

Method Detail

loadLogs

public void loadLogs(java.io.BufferedReader br,
                     ACSRemoteLogListener logListener,
                     ACSRemoteErrorListener errorListener,
                     int progressRange)

Load the logs from the given file in the Cache appending their starting positions in the index vector.

The logs are appended at the end of the cache as well as the new positions are appended at the end of the index vector. The load is performed in a thread as it might be very slow

The filter, discard level and audience of the engine are applied while loading. This is done by applying to ioHelper the same constraints defined in the LCEngine.

Parameters:

br - The the file to read

logListener - The callback for each new log read from the IO

errorListener - The listener of errors

progressRange - The range of the progress bar (if <=0 the progress bar is undetermined)

loadLogsFromUrl

public void loadLogsFromUrl(java.net.URL url,
                            ACSRemoteLogListener logListener,
                            ACSRemoteErrorListener errorListener)

Load logs from the passed url. Loading logs from url is done in 2 steps:

1. Download the file
2. Load the file

Downloading the file and the reading it allows to download and read compressed (gz) files.

Parameters:

logListener - The callback for each new log read from the IO

errorListener - The listener of errors

url - The url to read

saveLogs

public void saveLogs(java.lang.String fileName,
                     boolean compress,
                     int level,
                     LogCache cache)
              throws java.io.IOException

Save the logs in a file.

Parameters:

fileName - The name of the file to save

compress - true if the file must be compressed (GZIP)

level - The level of compression (ignored if compress is false)

cache - The cache that contains the logs

Throws:

java.io.IOException

See Also:

saveLogsFromThread

done

public void done(boolean sync)

Release the resource acquired by this object It terminates the thread so the object can be deleted by the JVM NOTE: when the thread is terminated it is not possible to request asynchronous services

Parameters:

sync - If it is true wait the termination of the threads before returning

bytesRead

public void bytesRead(long bytes)

Moves the progress bar of the progress monitor

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)

Change the label of the progress monitor

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)

isPerformingIO

public boolean isPerformingIO()

Check if a load/save is in progress

Returns:

true if a load/save is in progress

getIoHelper

public IOHelper getIoHelper()