org.alfresco.filesys.avm

Class AVMNetworkFile

java.lang.Object

org.alfresco.jlan.server.filesys.NetworkFile

org.alfresco.filesys.alfresco.AlfrescoNetworkFile

org.alfresco.filesys.avm.AVMNetworkFile

All Implemented Interfaces:

NetworkFileStateInterface

public class AVMNetworkFile
extends AlfrescoNetworkFile

AVM Network File Class

Holds the details of an open file, and provides access to the file data.

Author:

GKSpencer

Field Summary

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
AVMNetworkFile(AVMNodeDescriptor details, String avmPath, int avmVersion, org.alfresco.service.cmr.repository.NodeService nodeService, AVMService avmService) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	closeFile() Close the database file
void	flushFile() Flush any buffered output to the file
String	getMimeType() Return the mime type
boolean	hasContentChannel() Check if there is an open file channel to the content
boolean	isWritable() Return the writable state of the content channel
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	setMimeType(String mimeType) Set the mime type
String	toString() Return the network file details as a string
void	truncateFile(long siz) Truncate the file to the specified file size
void	writeFile(byte[] buf, int len, int pos, long fileOff) Write a block of data to the file.

Methods inherited from class org.alfresco.filesys.alfresco.AlfrescoNetworkFile

allowsOpenCloseViaNetworkFile, getFileState, setFileState

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

addLock, 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, wasCreated

Methods inherited from class java.lang.Object

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

Constructor Detail

AVMNetworkFile

public AVMNetworkFile(AVMNodeDescriptor details,
              String avmPath,
              int avmVersion,
              org.alfresco.service.cmr.repository.NodeService nodeService,
              AVMService avmService)

Class constructor

Parameters:

details - AVMNodeDescriptor

avmPath - String

avmVersion - int

nodeService - NodeService

avmService - AVMService

Method Detail

hasContentChannel

public final boolean hasContentChannel()

Check if there is an open file channel to the content

Returns:

boolean

getMimeType

public final String getMimeType()

Return the mime type

Returns:

String

setMimeType

public final void setMimeType(String mimeType)

Set the mime type

Parameters:

mimeType - String

openFile

public void openFile(boolean createFlag)
              throws IOException

Open the file

Specified by:

openFile in class NetworkFile

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 fileOff)
               throws IOException

Write a block of data to the file.

Specified by:

writeFile in class NetworkFile

Parameters:

buf - byte[]

len - int

pos - int

fileOff - long

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:

int

Throws:

IOException

flushFile

public void flushFile()
               throws IOException

Flush any buffered output to the file

Specified by:

flushFile in class NetworkFile

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()
               throws IOException

Close the database file

Specified by:

closeFile in class NetworkFile

Throws:

IOException

isWritable

public final boolean isWritable()

Return the writable state of the content channel

Returns:

boolean

toString

public String toString()

Return the network file details as a string

Overrides:

toString in class NetworkFile

Returns:

String