org.apache.axiom.attachments

Class AttachmentCacheMonitor

java.lang.Object

org.apache.axiom.attachments.AttachmentCacheMonitor

public final class AttachmentCacheMonitor
extends java.lang.Object

The CacheMonitor is responsible for deleting temporary attachment files after a timeout period has expired. The register method is invoked when the attachment file is created. The access method is invoked whenever the attachment file is accessed. The checkForAgedFiles method is invoked whenever the monitor should look for files to cleanup (delete).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AttachmentCacheMonitor.CleanupFilesTask

Field Summary

Fields

Modifier and Type	Field and Description
private static AttachmentCacheMonitor	_singleton
static java.lang.String	ATTACHMENT_TIMEOUT_PROPERTY
private int	attachmentTimeoutSeconds
private java.util.HashMap	files
(package private) static org.apache.commons.logging.Log	log
private java.lang.Long	priorDeleteMillis
private int	refreshSeconds
private java.util.Timer	timer

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AttachmentCacheMonitor() Constructor Intentionally private.

Method Summary

Modifier and Type	Method and Description
private void	_access(java.lang.String fileName)
private void	_checkForAgedFiles()
private java.lang.Boolean	_deleteFile(java.lang.String fileName)
private void	_register(java.lang.String fileName)
void	access(java.lang.String fileName) Indicates that the file was accessed.
void	checkForAgedFiles() Check for aged files and remove the aged ones.
private boolean	deleteFile(java.lang.String fileName)
static AttachmentCacheMonitor	getAttachmentCacheMonitor() Get or Create an AttachmentCacheMonitor singleton
private java.lang.Long	getTime()
int	getTimeout()
private boolean	isExpired(java.lang.Long oldTimeMillis, java.lang.Long newTimeMillis, int thresholdSecs)
void	register(java.lang.String fileName) Register a file name with the monitor.
void	setTimeout(int timeout) This method should Set a new timeout value

Methods inherited from class java.lang.Object

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

Field Detail

log

static org.apache.commons.logging.Log log

attachmentTimeoutSeconds

private int attachmentTimeoutSeconds

refreshSeconds

private int refreshSeconds

ATTACHMENT_TIMEOUT_PROPERTY

public static final java.lang.String ATTACHMENT_TIMEOUT_PROPERTY

See Also:

Constant Field Values

files

private java.util.HashMap files

priorDeleteMillis

private java.lang.Long priorDeleteMillis

timer

private java.util.Timer timer

_singleton

private static AttachmentCacheMonitor _singleton

Constructor Detail

AttachmentCacheMonitor

private AttachmentCacheMonitor()

Constructor Intentionally private. Callers should use getAttachmentCacheMonitor

See Also:

getAttachmentCacheMonitor

Method Detail

getAttachmentCacheMonitor

public static AttachmentCacheMonitor getAttachmentCacheMonitor()

Get or Create an AttachmentCacheMonitor singleton

Returns:

the singleton instance

getTimeout

public int getTimeout()

Returns:

timeout value in seconds

setTimeout

public void setTimeout(int timeout)

This method should Set a new timeout value

Parameters:

timeout - new timeout value in seconds

register

public void register(java.lang.String fileName)

Register a file name with the monitor. This will allow the Monitor to remove the file after the timeout period.

Parameters:

fileName -

access

public void access(java.lang.String fileName)

Indicates that the file was accessed.

Parameters:

fileName -

checkForAgedFiles

public void checkForAgedFiles()

Check for aged files and remove the aged ones.

_register

private void _register(java.lang.String fileName)

_access

private void _access(java.lang.String fileName)

_checkForAgedFiles

private void _checkForAgedFiles()

deleteFile

private boolean deleteFile(java.lang.String fileName)

_deleteFile

private java.lang.Boolean _deleteFile(java.lang.String fileName)

getTime

private java.lang.Long getTime()

isExpired

private boolean isExpired(java.lang.Long oldTimeMillis,
                          java.lang.Long newTimeMillis,
                          int thresholdSecs)