atg.vfs.journal

Class JournalingFile

java.lang.Object

atg.vfs.VirtualFileImpl

atg.vfs.journal.JournalingFile

All Implemented Interfaces:

atg.vfs.owner.OwnedFile, VirtualFile, java.io.Serializable

public class JournalingFile
extends atg.vfs.VirtualFileImpl
implements VirtualFile, atg.vfs.owner.OwnedFile

A virtual file which wraps another virtual file and notices changes made to the underlying file. The changes are passed to the associated JournalingFileSystem.

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class atg.vfs.VirtualFileImpl

EMPTY_STRING_ARRAY, mDescriptor, mFileSystem, mVFSName, mVirtualPath

Method Summary

Modifier and Type	Method and Description
boolean	canRead() Test if this file is readable
boolean	canWrite() Test if this file is writable
boolean	checkOwnership() check to see if it is possible to write the file given the current OwnerContext and the file's current ownership.
boolean	createNewFile() Create this file as a new empty file if it does not already exist.
boolean	delete() Delete this file.
boolean	exists() Test if this file exists.
java.lang.String	getAbsolutePath() Get the absolute path of this file.
java.lang.String	getCanonicalPath() Get the canonical form of the path of this file.
long	getChecksum() get the checksum of this file
VirtualFile	getChild(java.lang.String pName) Get the child file of this file with a given name.
VirtualFile	getChild(atg.vfs.VirtualPath pPath) Get the child file of this file with a given path.
java.io.InputStream	getInputStream() Get an input stream to read from this file
Journal	getJournal() Get property journal.
JournalingFileSystem	getJournalingFileSystem() Get property journalingFileSystem.
java.lang.String	getName() Get the name of this file.
java.io.OutputStream	getOutputStream() Get an output stream to write to this file.
java.lang.String	getParent() Get the parent part of the path of this file.
VirtualFile	getParentFile() Get the file representing the parent directory of this file.
java.lang.String	getPath() Get the path of this file
VirtualFile	getUnderlyingFile() Get property underlyingFile.
atg.vfs.VirtualPath	getVirtualPath() Get the path of this file
boolean	hasDifferentCase() Test whether the case of this file name as stored persistently differs from the case of the file name used to obtain the file.
boolean	isAbsolute() Test if this file represents an absolute path.
boolean	isDirectory() Test if this file is a directory.
boolean	isFile() Test if this file is a regular file.
long	lastModified() Get the time the file was last modified in millis.
long	length() Get the length of this file in bytes.
java.lang.String[]	list() Get a list of the files in the directory specified by this file.
java.lang.String[]	list(VirtualFilenameFilter pFilter) Get a list of the files in the directory specified by this file that satisfy the specified filter.
boolean	mkdir() Create the directory specified by this file.
boolean	mkdirs() Create the directory specified by this file, including any necessary parent directories.
boolean	renameTo(VirtualFile pDest) Rename this file.
void	setLastModified(long pTime) Set the time the file was last modified.
java.lang.String	toExternalForm() Get a URL string representation of this file.
java.lang.String	toString() Get a string representation of this object.

Methods inherited from class atg.vfs.VirtualFileImpl

copyFrom, equals, getChecksumCache, getExists, getFileDescriptor, getFileSystem, getLastModified, getLength, getList, getMetadataValue, getVersion, getVFSName, hashCode, invalidateChecksum, invalidateChecksum, list, mkdirs, setAllMetadata, setMetadataValue, updateLastModInChecksumCache

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface atg.vfs.VirtualFile

copyFrom, getFileDescriptor, getFileSystem, getLastModified, getLength, getList, getMetadataValue, getVersion, getVFSName, list, setAllMetadata, setMetadataValue

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Method Detail

getJournalingFileSystem

public JournalingFileSystem getJournalingFileSystem()

Get property journalingFileSystem. This is the file system in which this journaling file lives.

Returns:

journalingFileSystem

getJournal

public Journal getJournal()

Get property journal. This is the journal where modifications are kept.

Returns:

journal

getUnderlyingFile

public VirtualFile getUnderlyingFile()

Get property underlyingFile. This is the virtual file wrapped by this journaling file

Returns:

underlyingFile

createNewFile

public boolean createNewFile()
                      throws java.io.IOException

Create this file as a new empty file if it does not already exist. This file must not refer to a directory.

Specified by:

createNewFile in interface VirtualFile

Overrides:

createNewFile in class atg.vfs.VirtualFileImpl

Returns:

true if the file was created, else false

Throws:

java.io.IOException - if there is a problem creating the file

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Get an input stream to read from this file

Specified by:

getInputStream in interface VirtualFile

Returns:

the input stream

Throws:

java.io.IOException - if there is I/O trouble

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Get an output stream to write to this file. If the file does not exist it is created along with any directories required. The caller must ensure the stream is close()d or risk leaking resources.

Specified by:

getOutputStream in interface VirtualFile

Returns:

the output stream

Throws:

java.io.IOException - if there is I/O trouble

getChild

public VirtualFile getChild(java.lang.String pName)

Get the child file of this file with a given name. The name may not contain path separators.

Specified by:

getChild in interface VirtualFile

Overrides:

getChild in class atg.vfs.VirtualFileImpl

Parameters:

pName - name of child

Returns:

the child

getChild

public VirtualFile getChild(atg.vfs.VirtualPath pPath)

Get the child file of this file with a given path.

Specified by:

getChild in interface VirtualFile

Overrides:

getChild in class atg.vfs.VirtualFileImpl

Parameters:

pPath - virtual path of the child relative to this

Returns:

the child

getName

public java.lang.String getName()

Get the name of this file. The name is everything in the pathname after the last occurrence of the separator character.

Specified by:

getName in interface VirtualFile

Overrides:

getName in class atg.vfs.VirtualFileImpl

Returns:

the name of this file

getVirtualPath

public atg.vfs.VirtualPath getVirtualPath()

Get the path of this file

Specified by:

getVirtualPath in interface VirtualFile

Overrides:

getVirtualPath in class atg.vfs.VirtualFileImpl

Returns:

the path of this file

getPath

public java.lang.String getPath()

Get the path of this file

Specified by:

getPath in interface VirtualFile

Overrides:

getPath in class atg.vfs.VirtualFileImpl

Returns:

the path of this file

getAbsolutePath

public java.lang.String getAbsolutePath()

Get the absolute path of this file. The absolute path is system dependent.

Specified by:

getAbsolutePath in interface VirtualFile

Overrides:

getAbsolutePath in class atg.vfs.VirtualFileImpl

Returns:

the absolute path of this file

getCanonicalPath

public java.lang.String getCanonicalPath()
                                  throws java.io.IOException

Get the canonical form of the path of this file. The precise definition of canonical form is system dependent, but it usually specifies an absolute pathname in which all relative references and references to the current directory have been completely resolved. The canonical form of the path of a nonexistent file may not be defined.

Specified by:

getCanonicalPath in interface VirtualFile

Overrides:

getCanonicalPath in class atg.vfs.VirtualFileImpl

Returns:

the path

Throws:

java.io.IOException - if there is I/O trouble

getParent

public java.lang.String getParent()

Get the parent part of the path of this file. The parent part is generally everything leading up to the last occurrence of the separator character, although the precise definition is system dependent.

Specified by:

getParent in interface VirtualFile

Overrides:

getParent in class atg.vfs.VirtualFileImpl

Returns:

the parent part of this file's path, or null if this file's path has no parent part

getParentFile

public VirtualFile getParentFile()

Get the file representing the parent directory of this file.

Specified by:

getParentFile in interface VirtualFile

Overrides:

getParentFile in class atg.vfs.VirtualFileImpl

Returns:

the parent file, or null if this file is the root of the file system

exists

public boolean exists()

Test if this file exists.

Specified by:

exists in interface VirtualFile

Returns:

true if this file exists, else false

canRead

public boolean canRead()

Test if this file is readable

Specified by:

canRead in interface VirtualFile

Overrides:

canRead in class atg.vfs.VirtualFileImpl

Returns:

true if this file is readable, else false

canWrite

public boolean canWrite()

Test if this file is writable

Specified by:

canWrite in interface VirtualFile

Returns:

true if this file is writable, else false

isFile

public boolean isFile()

Test if this file is a regular file. A regular file is not a directory and not an OS specific special file. All virtual files created by this file system are guaranteed to be either directories or regular files.

Specified by:

isFile in interface VirtualFile

Overrides:

isFile in class atg.vfs.VirtualFileImpl

Returns:

true if this file is a regular file, else false

See Also:

atg.vfs.File#getPath(), SecurityManager.checkRead(java.lang.String)

isDirectory

public boolean isDirectory()

Test if this file is a directory.

Specified by:

isDirectory in interface VirtualFile

Returns:

true if this file is a directory, else false

See Also:

atg.vfs.File#getPath(), SecurityManager.checkRead(java.lang.String)

isAbsolute

public boolean isAbsolute()

Test if this file represents an absolute path.

Specified by:

isAbsolute in interface VirtualFile

Overrides:

isAbsolute in class atg.vfs.VirtualFileImpl

Returns:

true if this file is an absolute path, else false

See Also:

atg.vfs.File#getPath(), atg.vfs.File#separator

lastModified

public long lastModified()

Get the time the file was last modified in millis.

Specified by:

lastModified in interface VirtualFile

Returns:

the time

See Also:

atg.vfs.File#getPath(), SecurityManager.checkRead(java.lang.String)

setLastModified

public void setLastModified(long pTime)
                     throws java.io.IOException

Set the time the file was last modified.

Specified by:

setLastModified in interface VirtualFile

Parameters:

pTime - the time to set, in millis

Throws:

java.io.IOException - if there is I/O trouble

See Also:

SecurityManager.checkWrite(java.lang.String)

length

public long length()

Get the length of this file in bytes.

Specified by:

length in interface VirtualFile

Returns:

the length of this file in bytes, or 0 if the file does not exist

See Also:

atg.vfs.File#getPath(), SecurityManager.checkRead(java.lang.String)

renameTo

public boolean renameTo(VirtualFile pDest)
                 throws JournalRuntimeException

Rename this file.

Specified by:

renameTo in interface VirtualFile

Overrides:

renameTo in class atg.vfs.VirtualFileImpl

Parameters:

pDest - the new file name, must not be null

Returns:

true if the rename succeeded, else false

Throws:

JournalRuntimeException - if there was a problem adding this operation to the journal

See Also:

atg.vfs.File#getPath(), SecurityManager.checkWrite(java.lang.String)

mkdir

public boolean mkdir()
              throws JournalRuntimeException

Create the directory specified by this file.

Specified by:

mkdir in interface VirtualFile

Overrides:

mkdir in class atg.vfs.VirtualFileImpl

Returns:

true if the directory was created, else false

Throws:

JournalRuntimeException - if there was a problem adding this operation to the journal

See Also:

atg.vfs.File#getPath(), SecurityManager.checkWrite(java.lang.String)

mkdirs

public boolean mkdirs()
               throws JournalRuntimeException

Create the directory specified by this file, including any necessary parent directories.

Specified by:

mkdirs in interface VirtualFile

Overrides:

mkdirs in class atg.vfs.VirtualFileImpl

Returns:

true if the directory was created, else false

Throws:

JournalRuntimeException - if there was a problem adding this operation to the journal

See Also:

atg.vfs.File#getPath(), SecurityManager.checkWrite(java.lang.String)

list

public java.lang.String[] list()

Get a list of the files in the directory specified by this file.

Specified by:

list in interface VirtualFile

Returns:

the list of files. The list does not include the current directory or the parent directory. If this file does not refer to a directory, and empty array is returned.

See Also:

atg.vfs.File#getPath(), SecurityManager.checkRead(java.lang.String)

list

public java.lang.String[] list(VirtualFilenameFilter pFilter)

Get a list of the files in the directory specified by this file that satisfy the specified filter.

Specified by:

list in interface VirtualFile

Overrides:

list in class atg.vfs.VirtualFileImpl

Parameters:

pFilter -

Returns:

the list of files. The list does not include the current directory or the parent directory. If this file does not refer to a directory, and empty array is returned.

See Also:

atg.vfs.File#getPath(), VirtualFilenameFilter, SecurityManager.checkRead(java.lang.String)

delete

public boolean delete()
               throws JournalRuntimeException

Delete this file. If the file is a directory, it must be empty for deletion to succeed.

Specified by:

delete in interface VirtualFile

Overrides:

delete in class atg.vfs.VirtualFileImpl

Returns:

true if the file is successfully deleted, else false

Throws:

JournalRuntimeException - if there was a problem adding this delete operation to the journal

See Also:

atg.vfs.File#getPath(), SecurityManager.checkDelete(java.lang.String)

toExternalForm

public java.lang.String toExternalForm()

Get a URL string representation of this file.

Specified by:

toExternalForm in interface VirtualFile

Returns:

the string URL, may be null

hasDifferentCase

public boolean hasDifferentCase()

Test whether the case of this file name as stored persistently differs from the case of the file name used to obtain the file.

Specified by:

hasDifferentCase in interface VirtualFile

Overrides:

hasDifferentCase in class atg.vfs.VirtualFileImpl

Returns:

true if the case is different from the "stored" case, else false

getChecksum

public long getChecksum()
                 throws java.io.IOException

get the checksum of this file

Specified by:

getChecksum in interface VirtualFile

Overrides:

getChecksum in class atg.vfs.VirtualFileImpl

Throws:

java.io.IOException

checkOwnership

public boolean checkOwnership()
                       throws VirtualFileSystemException

check to see if it is possible to write the file given the current OwnerContext and the file's current ownership. Throws an IOException if attempts to write the file should result in an error. Note that a false return should not result in an error, rather in the file just not being written.

Specified by:

checkOwnership in interface atg.vfs.owner.OwnedFile

Throws:

VirtualFileSystemException

toString

public java.lang.String toString()

Get a string representation of this object.

Specified by:

toString in interface VirtualFile

Overrides:

toString in class atg.vfs.VirtualFileImpl

Returns:

the string