org.alfresco.jlan.smb.server.disk

Class EnhJavaFileDiskDriver

java.lang.Object

org.alfresco.jlan.smb.server.disk.EnhJavaFileDiskDriver

All Implemented Interfaces:

DeviceInterface, DiskInterface, FileLockingInterface

public class EnhJavaFileDiskDriver
extends Object
implements DiskInterface, FileLockingInterface

Disk interface implementation that uses the java.io.File class.

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	_globalCreateDate

Constructor Summary

Constructors

Constructor and Description
EnhJavaFileDiskDriver() Class constructor

Method Summary

Modifier and Type	Method and Description
protected FileInfo	buildFileInformation(String path, String relPath) Build the file information for the specified file/directory, if it exists.
void	closeFile(SrvSession sess, TreeConnection tree, NetworkFile file) Close the specified file
DeviceContext	createContext(String shareName, org.springframework.extensions.config.ConfigElement args) Parse and validate the parameter string and create a device context for this share
void	createDirectory(SrvSession sess, TreeConnection tree, FileOpenParams params) Create a new directory
NetworkFile	createFile(SrvSession sess, TreeConnection tree, FileOpenParams params) Create a new file
void	deleteDirectory(SrvSession sess, TreeConnection tree, String dir) Delete a directory
void	deleteFile(SrvSession sess, TreeConnection tree, String name) Delete a file
int	fileExists(SrvSession sess, TreeConnection tree, String name) Check if the specified file exists, and it is a file.
void	flushFile(SrvSession sess, TreeConnection tree, NetworkFile file) Flush buffered data for the specified file
FileInfo	getFileInformation(SrvSession sess, TreeConnection tree, String name) Return file information about the specified file
static long	getGlobalCreateDateTime() Return the global file creation date/time
LockManager	getLockManager(SrvSession sess, TreeConnection tree) Return the lock manager implementation associated with this virtual filesystem
boolean	isReadOnly(SrvSession sess, DeviceContext ctx) Determine if the disk device is read-only.
protected String	mapPath(String path) Map the input path to a real path, this may require changing the case of various parts of the path.
protected String	mapPath(String base, String path) Map the input path to a real path, this may require changing the case of various parts of the path.
NetworkFile	openFile(SrvSession sess, TreeConnection tree, FileOpenParams params) Open a file
int	readFile(SrvSession sess, TreeConnection tree, NetworkFile file, byte[] buf, int bufPos, int siz, long filePos) Read a block of data from a file
void	renameFile(SrvSession sess, TreeConnection tree, String oldName, String newName) Rename a file
long	seekFile(SrvSession sess, TreeConnection tree, NetworkFile file, long pos, int typ) Seek to the specified point within a file
void	setFileInformation(SrvSession sess, TreeConnection tree, String name, FileInfo info) Set file information
SearchContext	startSearch(SrvSession sess, TreeConnection tree, String searchPath, int attrib) Start a file search
void	treeClosed(SrvSession sess, TreeConnection tree) Connection closed to this device
void	treeOpened(SrvSession sess, TreeConnection tree) Connection opened to this disk device
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 a file

Methods inherited from class java.lang.Object

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

Field Detail

_globalCreateDate

protected static long _globalCreateDate

Constructor Detail

EnhJavaFileDiskDriver

public EnhJavaFileDiskDriver()

Class constructor

Method Detail

buildFileInformation

protected FileInfo buildFileInformation(String path,
                                        String relPath)

Build the file information for the specified file/directory, if it exists.

Parameters:

path - String

relPath - String

Returns:

FileInfo

closeFile

public void closeFile(SrvSession sess,
                      TreeConnection tree,
                      NetworkFile file)
               throws IOException

Close the specified file

Specified by:

closeFile in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

file - Network file details

Throws:

IOException

createDirectory

public void createDirectory(SrvSession sess,
                            TreeConnection tree,
                            FileOpenParams params)
                     throws IOException

Create a new directory

Specified by:

createDirectory in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

params - Directory parameters

Throws:

IOException

createFile

public NetworkFile createFile(SrvSession sess,
                              TreeConnection tree,
                              FileOpenParams params)
                       throws IOException

Create a new file

Specified by:

createFile in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

params - File open parameters

Returns:

NetworkFile

Throws:

IOException

deleteDirectory

public void deleteDirectory(SrvSession sess,
                            TreeConnection tree,
                            String dir)
                     throws IOException

Delete a directory

Specified by:

deleteDirectory in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

dir - Path of directory to delete

Throws:

IOException

deleteFile

public void deleteFile(SrvSession sess,
                       TreeConnection tree,
                       String name)
                throws IOException

Delete a file

Specified by:

deleteFile in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

name - Name of file to delete

Throws:

IOException

fileExists

public int fileExists(SrvSession sess,
                      TreeConnection tree,
                      String name)

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

Specified by:

fileExists in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

name - File name

Returns:

int

See Also:

FileStatus

flushFile

public void flushFile(SrvSession sess,
                      TreeConnection tree,
                      NetworkFile file)
               throws IOException

Flush buffered data for the specified file

Specified by:

flushFile in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

file - Network file

Throws:

IOException

getFileInformation

public FileInfo getFileInformation(SrvSession sess,
                                   TreeConnection tree,
                                   String name)
                            throws IOException

Return file information about the specified file

Specified by:

getFileInformation in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

name - File name

Returns:

SMBFileInfo

Throws:

IOException

isReadOnly

public boolean isReadOnly(SrvSession sess,
                          DeviceContext ctx)
                   throws IOException

Determine if the disk device is read-only.

Specified by:

isReadOnly in interface DiskInterface

Parameters:

sess - Session details

ctx - Device context

Returns:

true if the device is read-only, else false

Throws:

IOException - If an error occurs.

mapPath

protected final String mapPath(String path)
                        throws FileNotFoundException,
                               PathNotFoundException

Map the input path to a real path, this may require changing the case of various parts of the path.

Parameters:

path - Share relative path

Returns:

Real path on the local filesystem

Throws:

FileNotFoundException

PathNotFoundException

mapPath

protected final String mapPath(String base,
                               String path)
                        throws FileNotFoundException,
                               PathNotFoundException

Map the input path to a real path, this may require changing the case of various parts of the path. The base path is not checked, it is assumed to exist.

Parameters:

base - java.lang.String

path - java.lang.String

Returns:

java.lang.String

Throws:

FileNotFoundException - The path could not be mapped to a real path.

PathNotFoundException - Part of the path is not valid

openFile

public NetworkFile openFile(SrvSession sess,
                            TreeConnection tree,
                            FileOpenParams params)
                     throws IOException

Open a file

Specified by:

openFile in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

params - File open parameters

Returns:

NetworkFile

Throws:

IOException

readFile

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

Read a block of data from a file

Specified by:

readFile in interface DiskInterface

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:

IOException

renameFile

public void renameFile(SrvSession sess,
                       TreeConnection tree,
                       String oldName,
                       String newName)
                throws IOException

Rename a file

Specified by:

renameFile in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

oldName - Existing file name

newName - New file name

Throws:

IOException

seekFile

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

Seek to the specified point within a file

Specified by:

seekFile in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

file - Network file

pos - New file position

typ - Seek type

Returns:

New file position

Throws:

IOException

setFileInformation

public void setFileInformation(SrvSession sess,
                               TreeConnection tree,
                               String name,
                               FileInfo info)
                        throws IOException

Set file information

Specified by:

setFileInformation in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

name - File name

info - File information to be set

Throws:

IOException

startSearch

public SearchContext startSearch(SrvSession sess,
                                 TreeConnection tree,
                                 String searchPath,
                                 int attrib)
                          throws FileNotFoundException

Start a file search

Specified by:

startSearch in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

searchPath - Search path, may include wildcards

attrib - Search attributes

Returns:

SearchContext

Throws:

FileNotFoundException

truncateFile

public void truncateFile(SrvSession sess,
                         TreeConnection tree,
                         NetworkFile file,
                         long siz)
                  throws IOException

Truncate a file to the specified size

Specified by:

truncateFile in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

file - Network file details

siz - New file length

Throws:

IOException - The exception description.

writeFile

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

Write a block of data to a file

Specified by:

writeFile in interface DiskInterface

Parameters:

sess - Session details

tree - Tree connection

file - Network file

buf - Data to be written

bufoff - Offset of data within the buffer

siz - Number of bytes to be written

fileoff - Offset within the file to start writing the data

Returns:

Number of bytes actually written

Throws:

IOException - The exception description.

createContext

public DeviceContext createContext(String shareName,
                                   org.springframework.extensions.config.ConfigElement args)
                            throws DeviceContextException

Parse and validate the parameter string and create a device context for this share

Specified by:

createContext in interface DeviceInterface

Parameters:

shareName - String

args - ConfigElement

Returns:

DeviceContext

Throws:

DeviceContextException

treeOpened

public void treeOpened(SrvSession sess,
                       TreeConnection tree)

Connection opened to this disk device

Specified by:

treeOpened in interface DeviceInterface

Parameters:

sess - Server session

tree - Tree connection

treeClosed

public void treeClosed(SrvSession sess,
                       TreeConnection tree)

Connection closed to this device

Specified by:

treeClosed in interface DeviceInterface

Parameters:

sess - Server session

tree - Tree connection

getGlobalCreateDateTime

public static final long getGlobalCreateDateTime()

Return the global file creation date/time

Returns:

long

getLockManager

public LockManager getLockManager(SrvSession sess,
                                  TreeConnection tree)

Return the lock manager implementation associated with this virtual filesystem

Specified by:

getLockManager in interface FileLockingInterface

Parameters:

sess - SrvSession

tree - TreeConnection

Returns:

LockManager