NetworkFile (Alfresco JLan 5.2 API)

java.lang.Object
- org.alfresco.jlan.server.filesys.NetworkFile

Direct Known Subclasses:

DBNetworkFile, DCEPipeFile, JavaNetworkFile, MemoryNetworkFile, NIOJavaNetworkFile, PseudoFolderNetworkFile, PseudoNetworkFile
```
public abstract class NetworkFile
extends Object
```
The network file represents a file or directory on a filesystem. The server keeps track of the open files on a per session basis.
This class may be extended as required by your own disk driver class.

Author:

gkspencer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ATTRIBUTESONLY`
`static int`	`Created`
`static int`	`DelayedClose`
`static int`	`DelayedWriteError`
`static int`	`DeleteOnClose`
`static int`	`IOPending`
`protected long`	`m_accessDate`
`protected int`	`m_allowedAccess`
`protected int`	`m_attrib`
`protected boolean`	`m_closed`
`protected long`	`m_createDate`
`protected int`	`m_dirId`
`protected int`	`m_fid`
`protected long`	`m_fileSize`
`protected String`	`m_fullName`
`protected int`	`m_grantedAccess`
`protected long`	`m_modifyDate`
`protected String`	`m_name`
`protected int`	`m_streamId`
`protected String`	`m_streamName`
`protected long`	`m_uniqueId`
`protected int`	`m_writeCount`
`static int`	`READONLY`
`static int`	`READWRITE`
`static int`	`WRITEONLY`

Constructor Summary

Constructors
Constructor and Description
`NetworkFile(int fid)` Create a network file object with the specified file identifier.
`NetworkFile(int fid, int did)` Create a network file with the specified file and parent directory ids
`NetworkFile(int fid, int stid, int did)` Create a network file with the specified file id, stream id and parent directory id
`NetworkFile(String name)` Create a network file object with the specified file/directory name.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLock(FileLock lock)` Add a lock to the active lock list
`boolean`	`allowsOpenCloseViaNetworkFile()` Indicate whether the file can be opened/closed via the NetworkFile methods rather than the DiskInterface.
`void`	`close()` Close the file
`abstract void`	`closeFile()` Implementation of close
`abstract void`	`flushFile()` Flush any buffered output to the file
`long`	`getAccessDate()` Return the file access date/time
`FileAccessToken`	`getAccessToken()` Return the access token
`int`	`getAllowedAccess()` Return the allowed file access mode
`long`	`getCreationDate()` Return the file creation date/time
`int`	`getDirectoryId()` Return the parent directory identifier
`int`	`getFileAttributes()` Return the file attributes.
`int`	`getFileId()` Return the file identifier.
`long`	`getFileSize()` Get the file size, in bytes.
`int`	`getFileSizeInt()` Get the file size, in bytes.
`String`	`getFullName()` Return the full name, relative to the share.
`String`	`getFullNameStream()` Return the full name including the stream name, relative to the share.
`int`	`getGrantedAccess()` Return the granted file access mode.
`String`	`getGrantedAccessAsString()` Return the granted access as a string
`FileLock`	`getLockAt(int idx)` Get the details of an active lock from the list
`FileLockList`	`getLockList()` Return the lock list
`long`	`getModifyDate()` Return the file modify date/time
`String`	`getName()` Return the file/directory name.
`OpLockDetails`	`getOpLock()` Return the oplock details
`int`	`getProtocolId()` Return the protocol file id/handle
`int`	`getStreamId()` Return the stream id, zero indicates the main file stream
`String`	`getStreamName()` Return the stream name, if this is a stream
`long`	`getUniqueId()` Return the unique file identifier
`int`	`getWriteCount()` Get the write count for the file
`boolean`	`hasAccessDate()` Determine if the file access date/time is valid
`boolean`	`hasAccessToken()` Check if the file has an access token
`boolean`	`hasCreationDate()` Determine if the file creation date/time is valid
`boolean`	`hasDelayedClose()` Check if the delayed close is set
`boolean`	`hasDelayedWriteError()` Check if a delayed write error has occurred on this file
`boolean`	`hasDeleteOnClose()` Check if the delete on close flag has been set for this file
`boolean`	`hasIOPending()` Check if the file has an I/O request pending
`boolean`	`hasLocks()` Check if there are active locks on this file by this session
`boolean`	`hasModifyDate()` Determine if the file modification date/time is valid
`boolean`	`hasNTAttribute(int attr)` Check for NT attributes
`boolean`	`hasOpLock()` Check if there is an oplock on this file/handle
`void`	`incrementWriteCount()` Increment the write count
`boolean`	`isArchived()` Return the archived attribute status
`boolean`	`isClosed()` Determine if the file has been closed.
`boolean`	`isDirectory()` Return the directory file attribute status.
`boolean`	`isForce()`
`boolean`	`isHidden()` Return the hidden file attribute status.
`boolean`	`isReadOnly()` Return the read-only file attribute status.
`boolean`	`isStream()` Check if this is a stream file
`boolean`	`isSystem()` Return the system file attribute status.
`int`	`numberOfLocks()` Return the count of active locks
`abstract void`	`openFile(boolean createFlag)` Open the file
`abstract int`	`readFile(byte[] buf, int len, int pos, long fileOff)` Read from the file.
`void`	`removeAllLocks()` Remove all locks from the lock list
`void`	`removeLock(FileLock lock)` Remove a lock from the active lock list
`abstract long`	`seekFile(long pos, int typ)` Seek to the specified file position.
`void`	`setAccessDate(long dattim)` Set the file access date/time
`void`	`setAccessToken(FileAccessToken token)` Set, or clear, the access token
`void`	`setAllowedAccess(int mode)` Set the allowed access mode
`void`	`setAttributes(int attrib)` Set the file attributes, as specified by the SMBFileAttribute class.
`void`	`setClosed(boolean b)` Set the file closed state.
`void`	`setCreationDate(long dattim)` Set the file creation date/time
`void`	`setDelayedClose(boolean delayClose)` Set or clear the delayed close flag
`void`	`setDelayedWriteError(boolean err)` Set or clear the delayed write error flag
`void`	`setDeleteOnClose(boolean del)` Set, or clear, the delete on close flag
`void`	`setDirectoryId(int dirId)` Set the parent directory identifier
`void`	`setFileId(int fid)` Set the file identifier.
`void`	`setFileSize(int siz)` Set the file size.
`void`	`setFileSize(long siz)` Set the file size.
`void`	`setForce(boolean force)`
`void`	`setFullName(String name)` Set the full file name, relative to the share.
`void`	`setGrantedAccess(int mode)` Set the granted file access mode.
`void`	`setIOPending(boolean pending)` Set/clear the I/O pending flag
`void`	`setModifyDate(long dattim)` Set the file modification date/time
`void`	`setName(String name)` Set the file name.
`void`	`setOpLock(OpLockDetails oplock)` Set/clear the oplock on this file
`void`	`setProtocolId(int id)` Set the protocol level file id/handle
`void`	`setStatusFlag(int flag, boolean sts)` Set/clear a file status flag
`void`	`setStreamId(int id)` Set the stream id
`void`	`setStreamName(String name)` Set the stream name
`protected void`	`setUniqueId(int fid, int did)` Set the unique id using the file and directory id
`protected void`	`setUniqueId(long id)` Set the unique file identifier
`protected void`	`setUniqueId(String path)` Set the unique id using the full path string
`String`	`toString()` Return the file details as a string
`abstract void`	`truncateFile(long siz)` Truncate the file to the specified file size
`boolean`	`wasCreated()` Check if the file was created during the open
`abstract void`	`writeFile(byte[] buf, int len, int pos, long fileOff)` Write a block of data to the specified offset within file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ATTRIBUTESONLY
```
public static final int ATTRIBUTESONLY
```
    See Also:
    Constant Field Values
  - READONLY
```
public static final int READONLY
```
    See Also:
    Constant Field Values
  - WRITEONLY
```
public static final int WRITEONLY
```
    See Also:
    Constant Field Values
  - READWRITE
```
public static final int READWRITE
```
    See Also:
    Constant Field Values
  - IOPending
```
public static final int IOPending
```
    See Also:
    Constant Field Values
  - DeleteOnClose
```
public static final int DeleteOnClose
```
    See Also:
    Constant Field Values
  - DelayedWriteError
```
public static final int DelayedWriteError
```
    See Also:
    Constant Field Values
  - Created
```
public static final int Created
```
    See Also:
    Constant Field Values
  - DelayedClose
```
public static final int DelayedClose
```
    See Also:
    Constant Field Values
  - m_fid
```
protected int m_fid
```
  - m_dirId
```
protected int m_dirId
```
  - m_uniqueId
```
protected long m_uniqueId
```
  - m_name
```
protected String m_name
```
  - m_streamName
```
protected String m_streamName
```
  - m_streamId
```
protected int m_streamId
```
  - m_fullName
```
protected String m_fullName
```
  - m_attrib
```
protected int m_attrib
```
  - m_fileSize
```
protected long m_fileSize
```
  - m_createDate
```
protected long m_createDate
```
  - m_modifyDate
```
protected long m_modifyDate
```
  - m_accessDate
```
protected long m_accessDate
```
  - m_grantedAccess
```
protected int m_grantedAccess
```
  - m_allowedAccess
```
protected int m_allowedAccess
```
  - m_closed
```
protected boolean m_closed
```
  - m_writeCount
```
protected int m_writeCount
```
- Constructor Detail
  - NetworkFile
```
public NetworkFile(int fid)
```
    Create a network file object with the specified file identifier.
    
    Parameters:
    fid - int
  - NetworkFile
```
public NetworkFile(int fid,
           int did)
```
    Create a network file with the specified file and parent directory ids
    
    Parameters:
    fid - int
    did - int
  - NetworkFile
```
public NetworkFile(int fid,
           int stid,
           int did)
```
    Create a network file with the specified file id, stream id and parent directory id
    
    Parameters:
    fid - int
    stid - int
    did - int
  - NetworkFile
```
public NetworkFile(String name)
```
    Create a network file object with the specified file/directory name.
    
    Parameters:
    name - File name string.
- Method Detail
  - getDirectoryId
```
public final int getDirectoryId()
```
    Return the parent directory identifier
    
    Returns:
    int
  - getFileAttributes
```
public final int getFileAttributes()
```
    Return the file attributes.
    
    Returns:
    int
  - getFileId
```
public final int getFileId()
```
    Return the file identifier.
    
    Returns:
    int
  - getFileSize
```
public final long getFileSize()
```
    Get the file size, in bytes.
    
    Returns:
    long
  - getFileSizeInt
```
public final int getFileSizeInt()
```
    Get the file size, in bytes.
    
    Returns:
    int
  - getFullName
```
public final String getFullName()
```
    Return the full name, relative to the share.
    
    Returns:
    String
  - getFullNameStream
```
public final String getFullNameStream()
```
    Return the full name including the stream name, relative to the share.
    
    Returns:
    String
  - getGrantedAccess
```
public final int getGrantedAccess()
```
    Return the granted file access mode.
    
    Returns:
    int
  - getGrantedAccessAsString
```
public final String getGrantedAccessAsString()
```
    Return the granted access as a string
    
    Returns:
    String
  - getAllowedAccess
```
public final int getAllowedAccess()
```
    Return the allowed file access mode
    
    Returns:
    int
  - getName
```
public String getName()
```
    Return the file/directory name.
    
    Returns:
    String
  - getStreamId
```
public final int getStreamId()
```
    Return the stream id, zero indicates the main file stream
    
    Returns:
    int
  - getStreamName
```
public final String getStreamName()
```
    Return the stream name, if this is a stream
    
    Returns:
    String
  - getUniqueId
```
public final long getUniqueId()
```
    Return the unique file identifier
    
    Returns:
    long
  - isClosed
```
public final boolean isClosed()
```
    Determine if the file has been closed.
    
    Returns:
    boolean
  - isDirectory
```
public final boolean isDirectory()
```
    Return the directory file attribute status.
    
    Returns:
    true if the file is a directory, else false.
  - isHidden
```
public final boolean isHidden()
```
    Return the hidden file attribute status.
    
    Returns:
    true if the file is hidden, else false.
  - isReadOnly
```
public final boolean isReadOnly()
```
    Return the read-only file attribute status.
    
    Returns:
    true if the file is read-only, else false.
  - isSystem
```
public final boolean isSystem()
```
    Return the system file attribute status.
    
    Returns:
    true if the file is a system file, else false.
  - isArchived
```
public final boolean isArchived()
```
    Return the archived attribute status
    
    Returns:
    boolean
  - isStream
```
public final boolean isStream()
```
    Check if this is a stream file
    
    Returns:
    boolean
  - hasLocks
```
public final boolean hasLocks()
```
    Check if there are active locks on this file by this session
    
    Returns:
    boolean
  - hasNTAttribute
```
public final boolean hasNTAttribute(int attr)
```
    Check for NT attributes
    
    Parameters:
    attr - int
    
    Returns:
    boolean
  - hasAccessDate
```
public final boolean hasAccessDate()
```
    Determine if the file access date/time is valid
    
    Returns:
    boolean
  - getAccessDate
```
public final long getAccessDate()
```
    Return the file access date/time
    
    Returns:
    long
  - hasCreationDate
```
public final boolean hasCreationDate()
```
    Determine if the file creation date/time is valid
    
    Returns:
    boolean
  - getCreationDate
```
public final long getCreationDate()
```
    Return the file creation date/time
    
    Returns:
    long
  - hasDelayedWriteError
```
public final boolean hasDelayedWriteError()
```
    Check if a delayed write error has occurred on this file
    
    Returns:
    boolean
  - hasDeleteOnClose
```
public final boolean hasDeleteOnClose()
```
    Check if the delete on close flag has been set for this file
    
    Returns:
    boolean
  - hasIOPending
```
public final boolean hasIOPending()
```
    Check if the file has an I/O request pending
    
    Returns:
    boolean
  - hasDelayedClose
```
public final boolean hasDelayedClose()
```
    Check if the delayed close is set
    
    Returns:
    boolean
  - wasCreated
```
public final boolean wasCreated()
```
    Check if the file was created during the open
    
    Returns:
    boolean
  - hasModifyDate
```
public boolean hasModifyDate()
```
    Determine if the file modification date/time is valid
    
    Returns:
    boolean
  - getModifyDate
```
public final long getModifyDate()
```
    Return the file modify date/time
    
    Returns:
    long
  - getWriteCount
```
public final int getWriteCount()
```
    Get the write count for the file
    
    Returns:
    int
  - incrementWriteCount
```
public final void incrementWriteCount()
```
    Increment the write count
  - getProtocolId
```
public final int getProtocolId()
```
    Return the protocol file id/handle
    
    Returns:
    int
  - setAttributes
```
public final void setAttributes(int attrib)
```
    Set the file attributes, as specified by the SMBFileAttribute class.
    
    Parameters:
    attrib - int
  - setDeleteOnClose
```
public final void setDeleteOnClose(boolean del)
```
    Set, or clear, the delete on close flag
    
    Parameters:
    del - boolean
  - setDirectoryId
```
public final void setDirectoryId(int dirId)
```
    Set the parent directory identifier
    
    Parameters:
    dirId - int
  - setFileId
```
public final void setFileId(int fid)
```
    Set the file identifier.
    
    Parameters:
    fid - int
  - setFileSize
```
public final void setFileSize(long siz)
```
    Set the file size.
    
    Parameters:
    siz - long
  - setFileSize
```
public final void setFileSize(int siz)
```
    Set the file size.
    
    Parameters:
    siz - int
  - setFullName
```
public final void setFullName(String name)
```
    Set the full file name, relative to the share.
    
    Parameters:
    name - String
  - setGrantedAccess
```
public final void setGrantedAccess(int mode)
```
    Set the granted file access mode.
    
    Parameters:
    mode - int
  - setAllowedAccess
```
public final void setAllowedAccess(int mode)
```
    Set the allowed access mode
    
    Parameters:
    mode - int
  - setName
```
public final void setName(String name)
```
    Set the file name.
    
    Parameters:
    name - String
  - setIOPending
```
public final void setIOPending(boolean pending)
```
    Set/clear the I/O pending flag
    
    Parameters:
    pending - boolean
  - setStreamId
```
public final void setStreamId(int id)
```
    Set the stream id
    
    Parameters:
    id - int
  - setStreamName
```
public final void setStreamName(String name)
```
    Set the stream name
    
    Parameters:
    name - String
  - setClosed
```
public final void setClosed(boolean b)
```
    Set the file closed state.
    
    Parameters:
    b - boolean
  - setAccessDate
```
public final void setAccessDate(long dattim)
```
    Set the file access date/time
    
    Parameters:
    dattim - long
  - setCreationDate
```
public final void setCreationDate(long dattim)
```
    Set the file creation date/time
    
    Parameters:
    dattim - long
  - setDelayedWriteError
```
public final void setDelayedWriteError(boolean err)
```
    Set or clear the delayed write error flag
    
    Parameters:
    err - boolean
  - setDelayedClose
```
public final void setDelayedClose(boolean delayClose)
```
    Set or clear the delayed close flag
    
    Parameters:
    delayClose - boolean
  - setModifyDate
```
public final void setModifyDate(long dattim)
```
    Set the file modification date/time
    
    Parameters:
    dattim - long
  - setStatusFlag
```
public final void setStatusFlag(int flag,
                 boolean sts)
```
    Set/clear a file status flag
    
    Parameters:
    flag - int
    sts - boolean
  - addLock
```
public final void addLock(FileLock lock)
```
    Add a lock to the active lock list
    
    Parameters:
    lock - FileLock
  - removeLock
```
public final void removeLock(FileLock lock)
```
    Remove a lock from the active lock list
    
    Parameters:
    lock - FileLock
  - removeAllLocks
```
public final void removeAllLocks()
```
    Remove all locks from the lock list
  - numberOfLocks
```
public final int numberOfLocks()
```
    Return the count of active locks
    
    Returns:
    int
  - getLockAt
```
public final FileLock getLockAt(int idx)
```
    Get the details of an active lock from the list
    
    Parameters:
    idx - int
    
    Returns:
    FileLock
  - getLockList
```
public final FileLockList getLockList()
```
    Return the lock list
    
    Returns:
    FileLockList
  - hasOpLock
```
public final boolean hasOpLock()
```
    Check if there is an oplock on this file/handle
    
    Returns:
    boolean
  - getOpLock
```
public final OpLockDetails getOpLock()
```
    Return the oplock details
    
    Returns:
    OpLockDetails
  - setOpLock
```
public final void setOpLock(OpLockDetails oplock)
```
    Set/clear the oplock on this file
    
    Parameters:
    oplock - OpLockDetails
  - setUniqueId
```
protected final void setUniqueId(long id)
```
    Set the unique file identifier
    
    Parameters:
    id - long
  - setUniqueId
```
protected final void setUniqueId(int fid,
               int did)
```
    Set the unique id using the file and directory id
    
    Parameters:
    fid - int
    did - int
  - setUniqueId
```
protected final void setUniqueId(String path)
```
    Set the unique id using the full path string
    
    Parameters:
    path - String
  - setProtocolId
```
public final void setProtocolId(int id)
```
    Set the protocol level file id/handle
    
    Parameters:
    id - int
  - hasAccessToken
```
public final boolean hasAccessToken()
```
    Check if the file has an access token
    
    Returns:
    boolean
  - getAccessToken
```
public final FileAccessToken getAccessToken()
```
    Return the access token
    
    Returns:
    FileAccessToken
  - setAccessToken
```
public final void setAccessToken(FileAccessToken token)
```
    Set, or clear, the access token
    
    Parameters:
    token - FileAccessToken
  - openFile
```
public abstract void openFile(boolean createFlag)
                       throws IOException
```
    Open the file
    
    Parameters:
    createFlag - boolean
    
    Throws:
    
    IOException
  - readFile
```
public abstract int readFile(byte[] buf,
           int len,
           int pos,
           long fileOff)
                      throws IOException
```
    Read from the file.
    
    Parameters:
    buf - byte[]
    len - int
    pos - int
    fileOff - long
    
    Returns:
    Length of data read.
    
    Throws:
    
    IOException
  - writeFile
```
public abstract void writeFile(byte[] buf,
             int len,
             int pos,
             long fileOff)
                        throws IOException
```
    Write a block of data to the specified offset within file.
    
    Parameters:
    buf - byte[] buffer to write
    len - number of bytes to write from the buffer
    pos - offset within the buffer to write
    fileOff - long offset within the file to write.
    
    Throws:
    
    IOException
  - seekFile
```
public abstract long seekFile(long pos,
            int typ)
                       throws IOException
```
    Seek to the specified file position.
    
    Parameters:
    pos - long
    typ - int
    
    Returns:
    int
    
    Throws:
    
    IOException
  - flushFile
```
public abstract void flushFile()
                        throws IOException
```
    Flush any buffered output to the file
    
    Throws:
    
    IOException
  - truncateFile
```
public abstract void truncateFile(long siz)
                           throws IOException
```
    Truncate the file to the specified file size
    
    Parameters:
    siz - long
    
    Throws:
    
    IOException
  - closeFile
```
public abstract void closeFile()
                        throws IOException
```
    Implementation of close
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Close the file
    
    Throws:
    
    IOException
  - allowsOpenCloseViaNetworkFile
```
public boolean allowsOpenCloseViaNetworkFile()
```
    Indicate whether the file can be opened/closed via the NetworkFile methods rather than the DiskInterface. This is primarily for use by the NFS server code when caching open files. If possible the server will close the network file to free up file handles, but keep it in the NFS file cache for a short while in case the file is used again. Override this method to prevent the NFS server from closing the file until the file is removed from the NFS file cache, by returning false.
    
    Returns:
    boolean
  - isForce
```
public boolean isForce()
```
  - setForce
```
public void setForce(boolean force)
```
  - toString
```
public String toString()
```
    Return the file details as a string
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String

Class NetworkFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTRIBUTESONLY

READONLY

WRITEONLY

READWRITE

IOPending

DeleteOnClose

DelayedWriteError

Created

DelayedClose

m_fid

m_dirId

m_uniqueId

m_name

m_streamName

m_streamId

m_fullName

m_attrib

m_fileSize

m_createDate

m_modifyDate

m_accessDate

m_grantedAccess

m_allowedAccess

m_closed

m_writeCount

Constructor Detail

NetworkFile

NetworkFile

NetworkFile

NetworkFile

Method Detail

getDirectoryId

getFileAttributes

getFileId

getFileSize

getFileSizeInt

getFullName

getFullNameStream

getGrantedAccess

getGrantedAccessAsString

getAllowedAccess

getName

getStreamId

getStreamName

getUniqueId

isClosed

isDirectory

isHidden

isReadOnly

isSystem

isArchived

isStream

hasLocks

hasNTAttribute

hasAccessDate

getAccessDate

hasCreationDate

getCreationDate

hasDelayedWriteError

hasDeleteOnClose

hasIOPending

hasDelayedClose

wasCreated

hasModifyDate

getModifyDate

getWriteCount

incrementWriteCount

getProtocolId

setAttributes

setDeleteOnClose

setDirectoryId

setFileId

setFileSize

setFileSize