public class JournalingFileSystemService extends GenericService implements VirtualFileSystem, atg.vfs.DeployableVirtualFileSystem, atg.vfs.owner.OwnerCacheFileSystem
JournalingFileSystem
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
JournalingFileSystemService()
Constructs an instanceof JournalingFileSystemService
|
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
|
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, toString
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public JournalingFileSystemService()
public void setUpdateListeners(atg.vfs.VFSUpdateEventListener[] pUpdateListeners)
public atg.vfs.VFSUpdateEventListener[] getUpdateListeners()
public void setJournalDirectory(java.io.File pJournalDirectory)
public java.io.File getJournalDirectory()
public void setVirtualFileSystem(VirtualFileSystem pVirtualFileSystem)
public VirtualFileSystem getVirtualFileSystem()
public void setClearJournalOnUpdate(boolean pClearJournalOnUpdate)
public boolean isClearJournalOnUpdate()
public void setJournalFileContent(boolean pJournalFileContent)
public boolean isJournalFileContent()
public void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic void doStopService() throws ServiceException
doStopService
in class GenericService
ServiceException
- if the Service had a problem shutting downpublic Journal getJournal()
public VirtualFileSystemDescriptor getDescriptor()
getDescriptor
in interface VirtualFileSystem
public VirtualFile getFile(java.lang.String pPath)
getFile
in interface VirtualFileSystem
public VirtualFile getFile(atg.vfs.VirtualPath pPath)
getFile
in interface VirtualFileSystem
public java.lang.String separator()
separator
in interface VirtualFileSystem
public java.lang.String getVFSName()
getVFSName
in interface VirtualFileSystem
public void handleUpdate() throws atg.vfs.VFSUpdateException
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.
handleUpdate
in interface VirtualFileSystem
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.VFSUpdateException
public boolean deleteAllBeforeDate(long pPurgeDate)
deleteAllBeforeDate
in interface atg.vfs.DeployableVirtualFileSystem
public boolean deleteAllFiles()
deleteAllFiles
in interface atg.vfs.DeployableVirtualFileSystem
public void deleteOldEmptyFolders(long pPurgeDate, ApplicationLogging pLogger)
deleteOldEmptyFolders
in interface atg.vfs.DeployableVirtualFileSystem
public void setOwnerCache(atg.vfs.owner.OwnerCache pOwnerCache)
setOwnerCache
in interface atg.vfs.owner.OwnerCacheFileSystem
public atg.vfs.owner.OwnerCache getOwnerCache()
getOwnerCache
in interface atg.vfs.owner.OwnerCacheFileSystem
public void setOwnerCacheEnabled(boolean pOwnerCacheEnabled)
public boolean getOwnerCacheEnabled()
public void setOwnerCacheDataFile(java.io.File pOwnerCacheDataFile)
public java.io.File getOwnerCacheDataFile()