org.alfresco.jlan.server.filesys

Interface DiskInterface

All Superinterfaces:

DeviceInterface

All Known Implementing Classes:

DBDiskDriver, EnhJavaFileDiskDriver, JavaFileDiskDriver

public interface DiskInterface
extends DeviceInterface

The disk interface is implemented by classes that provide an interface for a disk type shared device.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeFile(SrvSession sess, TreeConnection tree, NetworkFile param) Close the file.
void	createDirectory(SrvSession sess, TreeConnection tree, FileOpenParams params) Create a new directory on this file system.
NetworkFile	createFile(SrvSession sess, TreeConnection tree, FileOpenParams params) Create a new file on the file system.
void	deleteDirectory(SrvSession sess, TreeConnection tree, java.lang.String dir) Delete the directory from the filesystem.
void	deleteFile(SrvSession sess, TreeConnection tree, java.lang.String name) Delete the specified file.
int	fileExists(SrvSession sess, TreeConnection tree, java.lang.String name) Check if the specified file exists, and whether it is a file or directory.
void	flushFile(SrvSession sess, TreeConnection tree, NetworkFile file) Flush any buffered output for the specified file.
FileInfo	getFileInformation(SrvSession sess, TreeConnection tree, java.lang.String name) Get the file information for the specified file.
boolean	isReadOnly(SrvSession sess, DeviceContext ctx) Determine if the disk device is read-only.
NetworkFile	openFile(SrvSession sess, TreeConnection tree, FileOpenParams params) Open a file on the file system.
int	readFile(SrvSession sess, TreeConnection tree, NetworkFile file, byte[] buf, int bufPos, int siz, long filePos) Read a block of data from the specified file.
void	renameFile(SrvSession sess, TreeConnection tree, java.lang.String oldName, java.lang.String newName) Rename the specified file.
long	seekFile(SrvSession sess, TreeConnection tree, NetworkFile file, long pos, int typ) Seek to the specified file position.
void	setFileInformation(SrvSession sess, TreeConnection tree, java.lang.String name, FileInfo info) Set the file information for the specified file.
SearchContext	startSearch(SrvSession sess, TreeConnection tree, java.lang.String searchPath, int attrib) Start a new search on the filesystem using the specified searchPath that may contain wildcards.
void	truncateFile(SrvSession sess, TreeConnection tree, NetworkFile file, long siz) Truncate a file to the specified size
int	writeFile(SrvSession sess, TreeConnection tree, NetworkFile file, byte[] buf, int bufoff, int siz, long fileoff) Write a block of data to the file.

Methods inherited from interface org.alfresco.jlan.server.core.DeviceInterface

createContext, treeClosed, treeOpened

Method Detail

closeFile

void closeFile(SrvSession sess,
             TreeConnection tree,
             NetworkFile param)
               throws java.io.IOException

Close the file.

Parameters:

sess - Server session

tree - Tree connection.

param - Network file context.

Throws:

java.io.IOException - If an error occurs.

createDirectory

void createDirectory(SrvSession sess,
                   TreeConnection tree,
                   FileOpenParams params)
                     throws java.io.IOException

Create a new directory on this file system.

Parameters:

sess - Server session

tree - Tree connection.

params - Directory create parameters

Throws:

java.io.IOException - If an error occurs.

createFile

NetworkFile createFile(SrvSession sess,
                     TreeConnection tree,
                     FileOpenParams params)
                       throws java.io.IOException

Create a new file on the file system.

Parameters:

sess - Server session

tree - Tree connection

params - File create parameters

Returns:

NetworkFile

Throws:

java.io.IOException - If an error occurs.

deleteDirectory

void deleteDirectory(SrvSession sess,
                   TreeConnection tree,
                   java.lang.String dir)
                     throws java.io.IOException

Delete the directory from the filesystem.

Parameters:

sess - Server session

tree - Tree connection

dir - Directory name.

Throws:

java.io.IOException - The exception description.

deleteFile

void deleteFile(SrvSession sess,
              TreeConnection tree,
              java.lang.String name)
                throws java.io.IOException

Delete the specified file.

Parameters:

sess - Server session

tree - Tree connection

name - File name

Throws:

java.io.IOException - The exception description.

fileExists

int fileExists(SrvSession sess,
             TreeConnection tree,
             java.lang.String name)

Check if the specified file exists, and whether it is a file or directory.

Parameters:

sess - Server session

tree - Tree connection

name - java.lang.String

Returns:

int

See Also:

FileStatus

flushFile

void flushFile(SrvSession sess,
             TreeConnection tree,
             NetworkFile file)
               throws java.io.IOException

Flush any buffered output for the specified file.

Parameters:

sess - Server session

tree - Tree connection

file - Network file context.

Throws:

java.io.IOException - The exception description.

getFileInformation

FileInfo getFileInformation(SrvSession sess,
                          TreeConnection tree,
                          java.lang.String name)
                            throws java.io.IOException

Get the file information for the specified file.

Parameters:

sess - Server session

tree - Tree connection

name - File name/path that information is required for.

Returns:

File information if valid, else null

Throws:

java.io.IOException - The exception description.

isReadOnly

boolean isReadOnly(SrvSession sess,
                 DeviceContext ctx)
                   throws java.io.IOException

Determine if the disk device is read-only.

Parameters:

sess - Server session

ctx - Device context

Returns:

boolean

Throws:

java.io.IOException - If an error occurs.

openFile

NetworkFile openFile(SrvSession sess,
                   TreeConnection tree,
                   FileOpenParams params)
                     throws java.io.IOException

Open a file on the file system.

Parameters:

sess - Server session

tree - Tree connection

params - File open parameters

Returns:

NetworkFile

Throws:

java.io.IOException - If an error occurs.

readFile

int readFile(SrvSession sess,
           TreeConnection tree,
           NetworkFile file,
           byte[] buf,
           int bufPos,
           int siz,
           long filePos)
             throws java.io.IOException

Read a block of data from the specified file.

Parameters:

sess - Session details

tree - Tree connection

file - Network file

buf - Buffer to return data to

bufPos - Starting position in the return buffer

siz - Maximum size of data to return

filePos - File offset to read data

Returns:

Number of bytes read

Throws:

java.io.IOException - The exception description.

renameFile

void renameFile(SrvSession sess,
              TreeConnection tree,
              java.lang.String oldName,
              java.lang.String newName)
                throws java.io.IOException

Rename the specified file.

Parameters:

sess - Server session

tree - Tree connection

oldName - java.lang.String

newName - java.lang.String

Throws:

java.io.IOException - The exception description.

seekFile

long seekFile(SrvSession sess,
            TreeConnection tree,
            NetworkFile file,
            long pos,
            int typ)
              throws java.io.IOException

Seek to the specified file position.

Parameters:

sess - Server session

tree - Tree connection

file - Network file.

pos - Position to seek to.

typ - Seek type.

Returns:

New file position, relative to the start of file.

Throws:

java.io.IOException

setFileInformation

void setFileInformation(SrvSession sess,
                      TreeConnection tree,
                      java.lang.String name,
                      FileInfo info)
                        throws java.io.IOException

Set the file information for the specified file.

Parameters:

sess - Server session

tree - Tree connection

name - java.lang.String

info - FileInfo

Throws:

java.io.IOException - The exception description.

startSearch

SearchContext startSearch(SrvSession sess,
                        TreeConnection tree,
                        java.lang.String searchPath,
                        int attrib)
                          throws java.io.FileNotFoundException

Start a new search on the filesystem using the specified searchPath that may contain wildcards.

Parameters:

sess - Server session

tree - Tree connection

searchPath - File(s) to search for, may include wildcards.

attrib - Attributes of the file(s) to search for, see class SMBFileAttribute.

Returns:

SearchContext

Throws:

java.io.FileNotFoundException - If the search could not be started.

truncateFile

void truncateFile(SrvSession sess,
                TreeConnection tree,
                NetworkFile file,
                long siz)
                  throws java.io.IOException

Truncate a file to the specified size

Parameters:

sess - Server session

tree - Tree connection

file - Network file details

siz - New file length

Throws:

java.io.IOException - The exception description.

writeFile

int writeFile(SrvSession sess,
            TreeConnection tree,
            NetworkFile file,
            byte[] buf,
            int bufoff,
            int siz,
            long fileoff)
              throws java.io.IOException

Write a block of data to the file.

Parameters:

sess - Server session

tree - Tree connection

file - Network file details

buf - byte[] Data to be written

bufoff - Offset within the buffer that the data starts

siz - int Data length

fileoff - Position within the file that the data is to be written.

Returns:

Number of bytes actually written

Throws:

java.io.IOException - The exception description.