atg.vfs.journal

Class JournalingFileSystemService

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.vfs.journal.JournalingFileSystemService

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, atg.vfs.DeployableVirtualFileSystem, atg.vfs.owner.OwnerCacheFileSystem, VirtualFileSystem, java.util.EventListener

public class JournalingFileSystemService
extends GenericService
implements VirtualFileSystem, atg.vfs.DeployableVirtualFileSystem, atg.vfs.owner.OwnerCacheFileSystem

A journaling file system service listener.

See Also:

JournalingFileSystem

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
JournalingFileSystemService() Constructs an instanceof JournalingFileSystemService

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteAllBeforeDate(long pPurgeDate) Recursively deletes all files in the VFS, based on timestamp Returns true if all aspects of the operation succeeded.
boolean	deleteAllFiles() Deletes all files in the VFS.
void	deleteOldEmptyFolders(long pPurgeDate, ApplicationLogging pLogger) Delete empty folders that are older than a certain date
void	doStartService() Start the JournalingFileSystemService
void	doStopService() Stop the JournalingFileSystemService
VirtualFileSystemDescriptor	getDescriptor() Return a descriptor of this file system
VirtualFile	getFile(java.lang.String pPath) Get a VirtualFile for some path.
VirtualFile	getFile(atg.vfs.VirtualPath pPath) Get a VirtualFile at some VirtualPath
Journal	getJournal() Get the journal
java.io.File	getJournalDirectory() Returns property JournalDirectory
atg.vfs.owner.OwnerCache	getOwnerCache() OwnerCache
java.io.File	getOwnerCacheDataFile() OwnerCacheDataFile
boolean	getOwnerCacheEnabled() OwnerCacheEnabled
atg.vfs.VFSUpdateEventListener[]	getUpdateListeners() Returns property UpdateListeners
java.lang.String	getVFSName() Get the name of this file system.
VirtualFileSystem	getVirtualFileSystem() Returns property VirtualFileSystem
void	handleUpdate() Handle an update.
boolean	isClearJournalOnUpdate() Returns property ClearJournalOnUpdate
boolean	isJournalFileContent() Returns property JournalFileContent
java.lang.String	separator() Get the directory separator for this filesystem
void	setClearJournalOnUpdate(boolean pClearJournalOnUpdate) Sets property ClearJournalOnUpdate
void	setJournalDirectory(java.io.File pJournalDirectory) Sets property JournalDirectory
void	setJournalFileContent(boolean pJournalFileContent) Sets property JournalFileContent
void	setOwnerCache(atg.vfs.owner.OwnerCache pOwnerCache)
void	setOwnerCacheDataFile(java.io.File pOwnerCacheDataFile)
void	setOwnerCacheEnabled(boolean pOwnerCacheEnabled)
void	setUpdateListeners(atg.vfs.VFSUpdateEventListener[] pUpdateListeners) Sets property UpdateListeners
void	setVirtualFileSystem(VirtualFileSystem pVirtualFileSystem) Sets property VirtualFileSystem

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

JournalingFileSystemService

public JournalingFileSystemService()

Constructs an instanceof JournalingFileSystemService

Method Detail

setUpdateListeners

public void setUpdateListeners(atg.vfs.VFSUpdateEventListener[] pUpdateListeners)

Sets property UpdateListeners

getUpdateListeners

public atg.vfs.VFSUpdateEventListener[] getUpdateListeners()

Returns property UpdateListeners

setJournalDirectory

public void setJournalDirectory(java.io.File pJournalDirectory)

Sets property JournalDirectory

getJournalDirectory

public java.io.File getJournalDirectory()

Returns property JournalDirectory

setVirtualFileSystem

public void setVirtualFileSystem(VirtualFileSystem pVirtualFileSystem)

Sets property VirtualFileSystem

getVirtualFileSystem

public VirtualFileSystem getVirtualFileSystem()

Returns property VirtualFileSystem

setClearJournalOnUpdate

public void setClearJournalOnUpdate(boolean pClearJournalOnUpdate)

Sets property ClearJournalOnUpdate

isClearJournalOnUpdate

public boolean isClearJournalOnUpdate()

Returns property ClearJournalOnUpdate

setJournalFileContent

public void setJournalFileContent(boolean pJournalFileContent)

Sets property JournalFileContent

isJournalFileContent

public boolean isJournalFileContent()

Returns property JournalFileContent

doStartService

public void doStartService()
                    throws ServiceException

Start the JournalingFileSystemService

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

doStopService

public void doStopService()
                   throws ServiceException

Stop the JournalingFileSystemService

Overrides:

doStopService in class GenericService

Throws:

ServiceException - if the Service had a problem shutting down

getJournal

public Journal getJournal()

Get the journal

getDescriptor

public VirtualFileSystemDescriptor getDescriptor()

Return a descriptor of this file system

Specified by:

getDescriptor in interface VirtualFileSystem

getFile

public VirtualFile getFile(java.lang.String pPath)

Get a VirtualFile for some path.

Specified by:

getFile in interface VirtualFileSystem

getFile

public VirtualFile getFile(atg.vfs.VirtualPath pPath)

Get a VirtualFile at some VirtualPath

Specified by:

getFile in interface VirtualFileSystem

separator

public java.lang.String separator()

Get the directory separator for this filesystem

Specified by:

separator in interface VirtualFileSystem

getVFSName

public java.lang.String getVFSName()

Get the name of this file system. The name is application specific. Implementations that are GenericServices should generally return their component path.

Specified by:

getVFSName in interface VirtualFileSystem

handleUpdate

public void handleUpdate()
                  throws atg.vfs.VFSUpdateException

Handle an update. This method is called by facilities to notify the virtual file system that one or more of the files in the the virtual file system has changed. This is part of the glue between Publishing and Dynamo.

The implementation of this method in the VirtualFileSystemImpl base class is suitable for most implementations. It is acceptable to make this a noop in a particular VFS implementation if that implementation is not used by Publishing.

Specified by:

handleUpdate in interface VirtualFileSystem

Throws:

atg.vfs.VFSUpdateException - if there is an error. It is important for implementations to not bury exceptions as facilities that call handleUpdate() use the exception to detect failures. If an implementation logs an error during handleUpdate() it should also throw this exception. This exception is a container exception to facilitate this. The exception also has properties that allow it to contain more useful information than in most exceptions.

See Also:

VFSUpdateException

deleteAllBeforeDate

public boolean deleteAllBeforeDate(long pPurgeDate)

Recursively deletes all files in the VFS, based on timestamp Returns true if all aspects of the operation succeeded. Filters files by date - deletes all before the supplied date. Does not delete directories.

Specified by:

deleteAllBeforeDate in interface atg.vfs.DeployableVirtualFileSystem

deleteAllFiles

public boolean deleteAllFiles()

Deletes all files in the VFS.

Specified by:

deleteAllFiles in interface atg.vfs.DeployableVirtualFileSystem

deleteOldEmptyFolders

public void deleteOldEmptyFolders(long pPurgeDate,
                         ApplicationLogging pLogger)

Delete empty folders that are older than a certain date

Specified by:

deleteOldEmptyFolders in interface atg.vfs.DeployableVirtualFileSystem

setOwnerCache

public void setOwnerCache(atg.vfs.owner.OwnerCache pOwnerCache)

Specified by:

setOwnerCache in interface atg.vfs.owner.OwnerCacheFileSystem

getOwnerCache

public atg.vfs.owner.OwnerCache getOwnerCache()

OwnerCache

Specified by:

getOwnerCache in interface atg.vfs.owner.OwnerCacheFileSystem

setOwnerCacheEnabled

public void setOwnerCacheEnabled(boolean pOwnerCacheEnabled)

getOwnerCacheEnabled

public boolean getOwnerCacheEnabled()

OwnerCacheEnabled

setOwnerCacheDataFile

public void setOwnerCacheDataFile(java.io.File pOwnerCacheDataFile)

getOwnerCacheDataFile

public java.io.File getOwnerCacheDataFile()

OwnerCacheDataFile