org.alfresco.jlan.server.filesys.db

Class CachedNetworkFile

java.lang.Object

org.alfresco.jlan.server.filesys.NetworkFile

org.alfresco.jlan.server.filesys.db.DBNetworkFile

org.alfresco.jlan.server.filesys.db.CachedNetworkFile

All Implemented Interfaces:

NetworkFileStateInterface

public class CachedNetworkFile
extends DBNetworkFile

Cached Data Network File Class

Caches the file data in the local filesystem in a temporary area.

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	DataLoadWaitTime
protected static long	DataPollSleepTime
protected FileSegment	m_cacheFile
protected int	m_lastReadLen
protected long	m_lastReadPos
protected boolean	m_seqOnly
protected int	m_seqReads

Fields inherited from class org.alfresco.jlan.server.filesys.db.DBNetworkFile

DBCacheFile

Fields inherited from class org.alfresco.jlan.server.filesys.NetworkFile

ATTRIBUTESONLY, Created, DelayedClose, DelayedWriteError, DeleteOnClose, IOPending, m_accessDate, m_allowedAccess, m_attrib, m_closed, m_createDate, m_dirId, m_fid, m_fileSize, m_fullName, m_grantedAccess, m_modifyDate, m_name, m_streamId, m_streamName, m_uniqueId, m_writeCount, READONLY, READWRITE, WRITEONLY

Constructor Summary

Constructors

Constructor and Description
CachedNetworkFile(String name, int fid, int stid, int did, FileStateProxy state, FileSegment segment, FileLoader loader) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	closeFile() Close the file
protected FileRequest	createFileRequest(int typ) Create a file load or save request.
protected void	finalize() Object is about to be garbage collected
void	flushFile() Flush any buffered output to the file
FileSegment	getFileSegment() Return the associated file segment
protected boolean	hasDebug() Determine if network file debug output is enabled
boolean	isSequentialOnly() Determine if the file will only be accessed sequentially
void	openFile(boolean createFlag) Open the file
int	readFile(byte[] buf, int len, int pos, long fileOff) Read from the file.
long	seekFile(long pos, int typ) Seek to the specified file position.
void	setSequentialOnly(boolean seq) Set the sequential access only flag
void	truncateFile(long siz) Truncate the file to the specified file size
protected void	updateFileSize(long siz, long alloc) Update the cached file information file size
void	writeFile(byte[] buf, int len, int pos, long offset) Write a block of data to the file.

Methods inherited from class org.alfresco.jlan.server.filesys.db.DBNetworkFile

getFileState, getLoader, getOwnerSessionId, getStatus, hasFileState, hasLoader, hasOwnerSessionId, setFileDetails, setFileState, setLoader, setOwnerSessionId, setStatus

Methods inherited from class org.alfresco.jlan.server.filesys.NetworkFile

addLock, allowsOpenCloseViaNetworkFile, close, getAccessDate, getAccessToken, getAllowedAccess, getCreationDate, getDirectoryId, getFileAttributes, getFileId, getFileSize, getFileSizeInt, getFullName, getFullNameStream, getGrantedAccess, getGrantedAccessAsString, getLockAt, getLockList, getModifyDate, getName, getOpLock, getProtocolId, getStreamId, getStreamName, getUniqueId, getWriteCount, hasAccessDate, hasAccessToken, hasCreationDate, hasDelayedClose, hasDelayedWriteError, hasDeleteOnClose, hasIOPending, hasLocks, hasModifyDate, hasNTAttribute, hasOpLock, incrementWriteCount, isArchived, isClosed, isDirectory, isForce, isHidden, isReadOnly, isStream, isSystem, numberOfLocks, removeAllLocks, removeLock, setAccessDate, setAccessToken, setAllowedAccess, setAttributes, setClosed, setCreationDate, setDelayedClose, setDelayedWriteError, setDeleteOnClose, setDirectoryId, setFileId, setFileSize, setFileSize, setForce, setFullName, setGrantedAccess, setIOPending, setModifyDate, setName, setOpLock, setProtocolId, setStatusFlag, setStreamId, setStreamName, setUniqueId, setUniqueId, setUniqueId, toString, wasCreated

Methods inherited from class java.lang.Object

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

Field Detail

DataLoadWaitTime

protected static final long DataLoadWaitTime

See Also:

Constant Field Values

DataPollSleepTime

protected static final long DataPollSleepTime

See Also:

Constant Field Values

m_cacheFile

protected FileSegment m_cacheFile

m_lastReadPos

protected long m_lastReadPos

m_lastReadLen

protected int m_lastReadLen

m_seqReads

protected int m_seqReads

m_seqOnly

protected boolean m_seqOnly

Constructor Detail

CachedNetworkFile

public CachedNetworkFile(String name,
                 int fid,
                 int stid,
                 int did,
                 FileStateProxy state,
                 FileSegment segment,
                 FileLoader loader)

Class constructor

Parameters:

name - String

fid - int

stid - int

did - int

state - FileStateProxy

segment - FileSegment

loader - FileLoader

Method Detail

getFileSegment

public final FileSegment getFileSegment()

Return the associated file segment

Returns:

FileSegment

isSequentialOnly

public final boolean isSequentialOnly()

Determine if the file will only be accessed sequentially

Returns:

boolean

setSequentialOnly

public final void setSequentialOnly(boolean seq)

Set the sequential access only flag

Parameters:

seq - boolean

openFile

public void openFile(boolean createFlag)
              throws IOException

Open the file

Overrides:

openFile in class DBNetworkFile

Parameters:

createFlag - boolean

Throws:

IOException

readFile

public int readFile(byte[] buf,
           int len,
           int pos,
           long fileOff)
             throws IOException

Read from the file.

Specified by:

readFile in class NetworkFile

Parameters:

buf - byte[]

len - int

pos - int

fileOff - long

Returns:

Length of data read.

Throws:

IOException

writeFile

public void writeFile(byte[] buf,
             int len,
             int pos,
             long offset)
               throws IOException

Write a block of data to the file.

Specified by:

writeFile in class NetworkFile

Parameters:

buf - byte[]

len - int

pos - int

offset - long

Throws:

IOException

flushFile

public void flushFile()
               throws IOException

Flush any buffered output to the file

Specified by:

flushFile in class NetworkFile

Throws:

IOException

seekFile

public long seekFile(long pos,
            int typ)
              throws IOException

Seek to the specified file position.

Specified by:

seekFile in class NetworkFile

Parameters:

pos - long

typ - int

Returns:

long

Throws:

IOException

truncateFile

public void truncateFile(long siz)
                  throws IOException

Truncate the file to the specified file size

Specified by:

truncateFile in class NetworkFile

Parameters:

siz - long

Throws:

IOException

closeFile

public void closeFile()

Close the file

Specified by:

closeFile in class NetworkFile

updateFileSize

protected final void updateFileSize(long siz,
                  long alloc)

Update the cached file information file size

Parameters:

siz - long

alloc - long

createFileRequest

protected FileRequest createFileRequest(int typ)

Create a file load or save request. This method may be overridden to allow extending of the SingleFileRequest class.

Parameters:

typ - int

Returns:

FileRequest

hasDebug

protected final boolean hasDebug()

Determine if network file debug output is enabled

Returns:

boolean

finalize

protected void finalize()

Object is about to be garbage collected

Overrides:

finalize in class Object