alma.acs.util.stringqueue

Class DefaultQueueFileHandlerImpl

java.lang.Object

alma.acs.util.stringqueue.TimestampedStringQueueFileHandler

alma.acs.util.stringqueue.DefaultQueueFileHandlerImpl

Direct Known Subclasses:

DefaultXmlQueueFileHandlerImpl

public class DefaultQueueFileHandlerImpl
extends TimestampedStringQueueFileHandler

A default implementation of IStringQueueFileHandler to create and delete cache files locally.

DefaultQueueFileHandlerImpl should be used when the queue contains plain strings or, more in general, when the files of the queue do not contain a header and a footer as it happens for example if the files contain XML strings. In this last case, prefer DefaultXmlQueueFileHandler

Since:

ACS 9.0

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
DefaultQueueFileHandlerImpl() Build the handler with the default size and prefix.
DefaultQueueFileHandlerImpl(long maxFileSize) Build the handler with the passed size for the files.
DefaultQueueFileHandlerImpl(long maxFileSize, java.lang.String prefix) Build the handler with the passed size and prefix.
DefaultQueueFileHandlerImpl(java.lang.String prefix) Build the handler with the default size for the files and the passed prefix

Method Summary

Modifier and Type	Method and Description
void	fileProcessed(java.io.File filePointer, java.lang.String minTime, java.lang.String maxTime) This method is invoked when all the strings in the passed file have been processed by the queue i.e.
java.io.File	getNewFile() Attempts to create the file for the strings in several places before giving up.

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

DefaultQueueFileHandlerImpl

public DefaultQueueFileHandlerImpl()

Build the handler with the default size and prefix.

See Also:

StringQueueFileHandler

DefaultQueueFileHandlerImpl

public DefaultQueueFileHandlerImpl(long maxFileSize)

Build the handler with the passed size for the files.

Parameters:

maxFileSize - The max size of the files of the cache.

See Also:

StringQueueFileHandler

DefaultQueueFileHandlerImpl

public DefaultQueueFileHandlerImpl(java.lang.String prefix)

Build the handler with the default size for the files and the passed prefix

Parameters:

prefix - The prefix of the name of the cache files

See Also:

StringQueueFileHandler

DefaultQueueFileHandlerImpl

public DefaultQueueFileHandlerImpl(long maxFileSize,
                                   java.lang.String prefix)

Build the handler with the passed size and prefix.

Parameters:

maxFileSize - The max size of the files of the cache.

prefix - The prefix of the name of the cache files

See Also:

StringQueueFileHandler

Method Detail

fileProcessed

public void fileProcessed(java.io.File filePointer,
                          java.lang.String minTime,
                          java.lang.String maxTime)

Description copied from class: TimestampedStringQueueFileHandler

This method is invoked when all the strings in the passed file have been processed by the queue i.e. queue is empty and the file can be deleted.

Note: implementors of this method shall ensure that the file is deleted.

The dates are represented as strings in ISO format.

Specified by:

fileProcessed in class TimestampedStringQueueFileHandler

Parameters:

filePointer - The file to be released

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

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

See Also:

alma.acs.util.stringqueue.IStringQueueFileHandler#fileProcessed(java.io.File, java.lang.String, java.lang.String)

getNewFile

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

Attempts to create the file for the strings in several places before giving up.

Specified by:

getNewFile in class TimestampedStringQueueFileHandler

Returns:

the newly created file

Throws:

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

See Also:

alma.acs.util.stringqueue.IStringQueueFileHandler#getNewFile()