alma.acs.logging.dialogs.error

Class ErrorLogFile

java.lang.Object

java.util.TimerTask

alma.acs.logging.dialogs.error.ErrorLogFile

All Implemented Interfaces:

java.lang.Runnable

public class ErrorLogFile
extends java.util.TimerTask

ErrorLogFile encapsulates a file adding methods to close the file when it has not been since used for long time.

In case of error while writing or creating the temporary file, the behavior depends on the value of retryOnError. If it is true.

The purpose of this class is to avoid having a file open when no I/O is performed for a long time. This is achieved:

• by creating the file only when the first writing is requested
• closing the file when no I/O is performed for a defined time interval

The used file is identified by its name;

Author:

acaproni

Constructor Summary

Constructors

Constructor and Description
ErrorLogFile(int timeout, java.lang.String prefix, java.lang.String suffix, java.lang.String folder, boolean deleteOnExit, boolean retryOnError) Constructor.

Method Summary

Modifier and Type	Method and Description
void	append(java.lang.String str) Append a string to the temporary file.
void	clear() Close the file(s) freeing all the resources
void	close() Close clear the file and stop the timer.
void	copy(java.io.OutputStream file) Copy the file in the passed output stream
protected void	finalize() Flush and close the file when the object is destroyed by the GC
java.lang.String	getFileName()
void	run() The method executed by the Timer.

Methods inherited from class java.util.TimerTask

cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorLogFile

public ErrorLogFile(int timeout,
                    java.lang.String prefix,
                    java.lang.String suffix,
                    java.lang.String folder,
                    boolean deleteOnExit,
                    boolean retryOnError)

Constructor.

Parameters:

timeout - The number of seconds before closing the file

prefix - The prefix of the temporary file

suffix - The suffix of the temporary file

folder - The name of the folder where the new file must be created; if it is null or empty, then the current folder is used

deleteOnExit - if true the file s deleted when the application exits

retryOnError - if true tries to open the file even if a previous attempt failed

Method Detail

run

public void run()

The method executed by the Timer.

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class java.util.TimerTask

See Also:

Timer}

append

public void append(java.lang.String str)
            throws java.io.IOException

Append a string to the temporary file.

Parameters:

str - The string to append in the file

Throws:

java.io.IOException

copy

public void copy(java.io.OutputStream file)
          throws java.io.FileNotFoundException,
                 java.io.IOException

Copy the file in the passed output stream

Parameters:

file - The stream to copy the content of the file into

Throws:

java.io.FileNotFoundException

java.io.IOException

clear

public void clear()

Close the file(s) freeing all the resources

This is the last method executed by this class

finalize

protected void finalize()
                 throws java.lang.Throwable

Flush and close the file when the object is destroyed by the GC

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

close

public void close()

Close clear the file and stop the timer.

This is the last method to execute.

getFileName

public java.lang.String getFileName()

Returns:

the fileName