alma.acs.xmlfilestore.common

Class QueueFileHandler

java.lang.Object

alma.acs.util.stringqueue.TimestampedStringQueueFileHandler

alma.acs.xmlfilestore.common.QueueFileHandler

public class QueueFileHandler
extends TimestampedStringQueueFileHandler

Implements TimestampedStringQueueFileHandler to rename the file once it has been processed. The final name initially agreed in ICT-4314, has been redefined in ICT-5523 to show the creation and closing timestamps of the file instead of oldest and newer timestamps in the string.

Author:

acaproni

Field Summary

Fields inherited from class alma.acs.util.stringqueue.TimestampedStringQueueFileHandler

DEFAULT_PREFIX, DEFAULT_SIZE, maxFilesSize, MAXSIZE_PROPERTY_NAME, prefix

Constructor Summary

Constructors

Constructor and Description
QueueFileHandler(ContainerServices cs, java.lang.String folder, int myFileMax, long myMaxFileSize, java.lang.String fileNamePrefix, java.lang.String faultFamily) Constructor

Method Summary

Modifier and Type	Method and Description
void	fileProcessed(java.io.File oldFile, java.lang.String earliestTimestamp, java.lang.String lastTimestamp) In ICT-5523, it has been decided that the file name must be that of the creation and closing of the file.
java.io.File	getNewFile() Create and return a new file for reading and writing.

Methods inherited from class alma.acs.util.stringqueue.TimestampedStringQueueFileHandler

getMaxFileSize, getPrefix

Methods inherited from class java.lang.Object

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

Constructor Detail

QueueFileHandler

public QueueFileHandler(ContainerServices cs,
                        java.lang.String folder,
                        int myFileMax,
                        long myMaxFileSize,
                        java.lang.String fileNamePrefix,
                        java.lang.String faultFamily)
                 throws java.lang.Exception

Constructor

Parameters:

myLogger - The logger

folder - The folder to save XMLs

myFileMax - Max number of XML files to keep in the folder

myMaxFileSize - Max length of each XML file

fileNamePrefix - The prefix to each name of XML file

faultFamily - The FF to send alarms

Throws:

java.lang.Exception

Method Detail

getNewFile

public java.io.File getNewFile()
                        throws java.io.IOException

Description copied from class: TimestampedStringQueueFileHandler

Create and return a new file for reading and writing.

The created file will be used to store strings and accessed randomly by the engine. Note: implementors of this method should ensure tha the file is deleted for example setting deleteOnExit().

Specified by:

getNewFile in class TimestampedStringQueueFileHandler

Returns:

the newly created file

Throws:

java.io.IOException - In case of error creating the file

See Also:

TimestampedStringQueueFileHandlerr#getNewFile()

fileProcessed

public void fileProcessed(java.io.File oldFile,
                          java.lang.String earliestTimestamp,
                          java.lang.String lastTimestamp)

In ICT-5523, it has been decided that the file name must be that of the creation and closing of the file.

Specified by:

fileProcessed in class TimestampedStringQueueFileHandler

Parameters:

oldFile - The file to be released

earliestTimestamp - The min timestamp of the strings in cache (null if the file is empty)

lastTimestamp - The max timestamp of the strings in cache (null if the file is empty)

See Also:

TimestampedStringQueueFileHandlerr#fileProcessed(java.io.File,java.lang.String, java.lang.String)