org.alfresco.jlan.server.filesys.db

Class DBDiskDriver

java.lang.Object

org.alfresco.jlan.server.filesys.db.DBDiskDriver

All Implemented Interfaces:

DeviceInterface, DiskInterface, DiskSizeInterface, DiskVolumeInterface, FileIdInterface, SecurityDescriptorInterface, SymbolicLinkInterface, FileLockingInterface, OpLockInterface, NTFSStreamsInterface

public class DBDiskDriver
extends Object
implements DiskInterface, DiskSizeInterface, DiskVolumeInterface, NTFSStreamsInterface, FileLockingInterface, FileIdInterface, SymbolicLinkInterface, OpLockInterface, SecurityDescriptorInterface

Database Disk Driver Class

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
static String	DBStreamList
static int	DefaultNFSDirMode
static int	DefaultNFSFileMode
static int	MaxFileNameLen
static long	MaxTimestampValue

Constructor Summary

Constructors

Constructor and Description
DBDiskDriver()

Method Summary

Methods

Modifier and Type	Method and Description
String	buildPathForFileId(SrvSession sess, TreeConnection tree, int dirid, int fileid) Convert a file id to a share relative path
void	closeFile(SrvSession sess, TreeConnection tree, NetworkFile file) Close the specified file
protected void	closeStream(SrvSession sess, TreeConnection tree, NetworkFile stream) Close an NTFS stream
DeviceContext	createContext(String shareName, org.springframework.extensions.config.ConfigElement args) Parse/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 entry
protected NetworkFile	createStream(SrvSession sess, TreeConnection tree, FileOpenParams params, FileState parent, DBDeviceContext dbCtx) Create a new stream with the specified parent file
void	deleteDirectory(SrvSession sess, TreeConnection tree, String dir) Delete a directory
void	deleteFile(SrvSession sess, TreeConnection tree, String name) Delete a file
protected void	deleteStream(SrvSession sess, TreeConnection tree, String name) Delete a stream within a file
int	fileExists(SrvSession sess, TreeConnection tree, String name) Check if the specified file exists, and it is a file.
protected int	findParentDirectoryId(DBDeviceContext ctx, String path, boolean filePath) Find the directory id for the parent directory in the specified path
protected int[]	findParentDirectoryIdList(DBDeviceContext ctx, String path, boolean filePath) Find the directory ids for the specified path list
void	flushFile(SrvSession sess, TreeConnection tree, NetworkFile file) Flush buffered data for the specified file
void	getDiskInformation(DiskDeviceContext ctx, SrvDiskInfo info) Return disk information about a shared filesystem
protected DBFileInfo	getFileDetails(String path, DBDeviceContext dbCtx) Get the file id for a file
protected DBFileInfo	getFileDetails(String path, DBDeviceContext dbCtx, FileState fstate) Get the file id for a file
protected int	getFileId(String path, String name, int dirId, DBDeviceContext dbCtx) Get the file id for a file
DBFileInfo	getFileInfo(String path, int dirId, int fid, DBDeviceContext dbCtx) Return file information about the specified file, using the internal file id
FileInfo	getFileInformation(SrvSession sess, TreeConnection tree, String name) Return file information about the specified file
protected FileState	getFileState(String path, DBDeviceContext ctx, boolean create) Get the cached file state for the specified path
LockManager	getLockManager(SrvSession sess, TreeConnection tree) Return the lock manager implementation
OpLockManager	getOpLockManager(SrvSession sess, TreeConnection tree) Return the oplock manager implementation
protected void	getRetentionDetailsForState(DBDeviceContext dbCtx, FileState fstate) Load the retention details for a file state, if enabled
int	getSecurityDescriptorLength(SrvSession sess, TreeConnection tree, NetworkFile netFile) Return the security descriptor length for the specified file
DBFileInfo	getStreamInfo(FileState parent, String[] paths, DBDeviceContext dbCtx) Get the details for a file stream
StreamInfo	getStreamInformation(SrvSession sess, TreeConnection tree, StreamInfo streamInfo) Get the stream information for the specified file stream
StreamInfoList	getStreamList(SrvSession sess, TreeConnection tree, String fileName) Return the list of available streams for the specified file
VolumeInfo	getVolumeInformation(DiskDeviceContext ctx) Return the volume information
protected boolean	hasDebug() Check if general debug output is enabled
boolean	hasStreamsEnabled(SrvSession sess, TreeConnection tree) Determine if NTFS streams support is enabled.
boolean	hasSymbolicLinksEnabled(SrvSession sess, TreeConnection tree) Determine if symbolic links are enabled
boolean	isOpLocksEnabled(SrvSession sess, TreeConnection tree) Enable/disable oplock support
boolean	isReadOnly(SrvSession sess, DeviceContext ctx) Determine if the disk device is read-only.
SecurityDescriptor	loadSecurityDescriptor(SrvSession sess, TreeConnection tree, NetworkFile netFile) Load a security descriptor for the specified file
protected StreamInfoList	loadStreamList(FileState fstate, DBFileInfo finfo, DBDeviceContext dbCtx, boolean dbLoad) Load the stream list for the specified file
NetworkFile	openFile(SrvSession sess, TreeConnection tree, FileOpenParams params) Open a file
protected NetworkFile	openStream(SrvSession sess, TreeConnection tree, FileOpenParams params, FileState parent, DBDeviceContext dbCtx) Open an existing stream with the specified parent file
int	readFile(SrvSession sess, TreeConnection tree, NetworkFile file, byte[] buf, int bufPos, int siz, long pos) Read a block of data from a file
String	readSymbolicLink(SrvSession sess, TreeConnection tree, String path) Read the link data for a symbolic link
void	renameFile(SrvSession sess, TreeConnection tree, String oldName, String newName) Rename a file
void	renameStream(SrvSession sess, TreeConnection tree, String oldName, String newName, boolean overWrite) Rename a stream
void	saveSecurityDescriptor(SrvSession sess, TreeConnection tree, NetworkFile netFile, SecurityDescriptor secDesc) Save the security descriptor for the specified 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 search of the file system
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

DBStreamList

public static final String DBStreamList

See Also:

Constant Field Values

DefaultNFSFileMode

public static final int DefaultNFSFileMode

See Also:

Constant Field Values

DefaultNFSDirMode

public static final int DefaultNFSDirMode

See Also:

Constant Field Values

MaxFileNameLen

public static final int MaxFileNameLen

See Also:

Constant Field Values

MaxTimestampValue

public static final long MaxTimestampValue

See Also:

Constant Field Values

Constructor Detail

DBDiskDriver

public DBDiskDriver()

Method Detail

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 create parameters

Throws:

IOException

createFile

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

Create a new file entry

Specified by:

createFile in interface DiskInterface

Parameters:

sess - SrvSession

tree - TreeConnection

params - FileOpenParams

Returns:

NetworkFile

Throws:

IOException - If an error occurs.

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.

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 pos)
             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

pos - 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 search of the file system

Specified by:

startSearch in interface DiskInterface

Parameters:

sess - SrvSession

tree - TreeConnection

searchPath - String

attrib - int

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/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

getFileDetails

protected final DBFileInfo getFileDetails(String path,
                        DBDeviceContext dbCtx)

Get the file id for a file

Parameters:

path - String

dbCtx - DBDeviceContext

Returns:

DBFileInfo

getFileDetails

protected final DBFileInfo getFileDetails(String path,
                        DBDeviceContext dbCtx,
                        FileState fstate)

Get the file id for a file

Parameters:

path - String

dbCtx - DBDeviceContext

fstate - FileState

Returns:

DBFileInfo

getFileId

protected final int getFileId(String path,
            String name,
            int dirId,
            DBDeviceContext dbCtx)

Get the file id for a file

Parameters:

path - String

name - String

dirId - int

dbCtx - DBDeviceContext

Returns:

int

getRetentionDetailsForState

protected final void getRetentionDetailsForState(DBDeviceContext dbCtx,
                               FileState fstate)
                                          throws DBException

Load the retention details for a file state, if enabled

Parameters:

dbCtx - DBDeviceContext

fstate - FileState

Throws:

DBException

findParentDirectoryId

protected final int findParentDirectoryId(DBDeviceContext ctx,
                        String path,
                        boolean filePath)

Find the directory id for the parent directory in the specified path

Parameters:

ctx - DBDeviceContext

path - String

filePath - boolean

Returns:

int

findParentDirectoryIdList

protected final int[] findParentDirectoryIdList(DBDeviceContext ctx,
                              String path,
                              boolean filePath)

Find the directory ids for the specified path list

Parameters:

ctx - DBDeviceContext

path - String

filePath - boolean

Returns:

int[]

getFileInfo

public DBFileInfo getFileInfo(String path,
                     int dirId,
                     int fid,
                     DBDeviceContext dbCtx)

Return file information about the specified file, using the internal file id

Parameters:

path - String

dirId - int

fid - int

dbCtx - DBDeviceContext

Returns:

DBFileInfo

getStreamInfo

public DBFileInfo getStreamInfo(FileState parent,
                       String[] paths,
                       DBDeviceContext dbCtx)

Get the details for a file stream

Parameters:

parent - FileState

paths - String[]

dbCtx - DBDeviceContext

Returns:

DBFileInfo

getFileState

protected final FileState getFileState(String path,
                     DBDeviceContext ctx,
                     boolean create)

Get the cached file state for the specified path

Parameters:

path - String

ctx - DBDeviceContext

create - boolean

Returns:

FileState

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

hasDebug

protected final boolean hasDebug()

Check if general debug output is enabled

Returns:

boolean

getDiskInformation

public final void getDiskInformation(DiskDeviceContext ctx,
                      SrvDiskInfo info)
                              throws IOException

Return disk information about a shared filesystem

Specified by:

getDiskInformation in interface DiskSizeInterface

Parameters:

ctx - DiskDeviceContext

info - SrvDiskInfo

Throws:

IOException

hasStreamsEnabled

public boolean hasStreamsEnabled(SrvSession sess,
                        TreeConnection tree)

Determine if NTFS streams support is enabled. Check if the associated file loader supports NTFS streams.

Specified by:

hasStreamsEnabled in interface NTFSStreamsInterface

Parameters:

sess - SrvSession

tree - TreeConnection

Returns:

boolean

getStreamInformation

public StreamInfo getStreamInformation(SrvSession sess,
                              TreeConnection tree,
                              StreamInfo streamInfo)
                                throws IOException

Get the stream information for the specified file stream

Specified by:

getStreamInformation in interface NTFSStreamsInterface

Parameters:

sess - SrvSession

tree - TreeConnection

streamInfo - StreamInfo

Returns:

StreamInfo

Throws:

IOException

getStreamList

public StreamInfoList getStreamList(SrvSession sess,
                           TreeConnection tree,
                           String fileName)
                             throws IOException

Return the list of available streams for the specified file

Specified by:

getStreamList in interface NTFSStreamsInterface

Parameters:

sess - SrvSession

tree - TreeConnection

fileName - String

Returns:

StreamInfoList

Throws:

IOException

createStream

protected final NetworkFile createStream(SrvSession sess,
                       TreeConnection tree,
                       FileOpenParams params,
                       FileState parent,
                       DBDeviceContext dbCtx)
                                  throws IOException

Create a new stream with the specified parent file

Parameters:

sess - SrvSession

tree - TreeConnection

params - FileOpenParams

parent - FileState

dbCtx - DBDeviceContext

Returns:

NetworkFile

Throws:

IOException

openStream

protected final NetworkFile openStream(SrvSession sess,
                     TreeConnection tree,
                     FileOpenParams params,
                     FileState parent,
                     DBDeviceContext dbCtx)
                                throws IOException

Open an existing stream with the specified parent file

Parameters:

sess - SrvSession

tree - TreeConnection

params - FileOpenParams

parent - FileState

dbCtx - DBDeviceContext

Returns:

NetworkFile

Throws:

IOException

closeStream

protected final void closeStream(SrvSession sess,
               TreeConnection tree,
               NetworkFile stream)
                          throws IOException

Close an NTFS stream

Parameters:

sess - Session details

tree - Tree connection

stream - Network file details

Throws:

IOException

deleteStream

protected final void deleteStream(SrvSession sess,
                TreeConnection tree,
                String name)
                           throws IOException

Delete a stream within a file

Parameters:

sess - SrvSession

tree - TreeConnection

name - String

Throws:

IOException

loadStreamList

protected final StreamInfoList loadStreamList(FileState fstate,
                            DBFileInfo finfo,
                            DBDeviceContext dbCtx,
                            boolean dbLoad)

Load the stream list for the specified file

Parameters:

fstate - FileState

finfo - DBFileInfo

dbCtx - DBDeviceContext

dbLoad - boolean

Returns:

StreamInfoList

renameStream

public void renameStream(SrvSession sess,
                TreeConnection tree,
                String oldName,
                String newName,
                boolean overWrite)
                  throws IOException

Rename a stream

Specified by:

renameStream in interface NTFSStreamsInterface

Parameters:

sess - SrvSession

tree - TreeConnection

oldName - String

newName - String

overWrite - boolean

Throws:

IOException

getVolumeInformation

public VolumeInfo getVolumeInformation(DiskDeviceContext ctx)

Return the volume information

Specified by:

getVolumeInformation in interface DiskVolumeInterface

Parameters:

ctx - DiskDeviceContext

Returns:

VolumeInfo

getLockManager

public LockManager getLockManager(SrvSession sess,
                         TreeConnection tree)

Return the lock manager implementation

Specified by:

getLockManager in interface FileLockingInterface

Parameters:

sess - SrvSession

tree - TreeConnection

Returns:

LockManager

getOpLockManager

public OpLockManager getOpLockManager(SrvSession sess,
                             TreeConnection tree)

Return the oplock manager implementation

Specified by:

getOpLockManager in interface OpLockInterface

Parameters:

sess - SrvSession

tree - TreeConnection

Returns:

OpLockManager

isOpLocksEnabled

public boolean isOpLocksEnabled(SrvSession sess,
                       TreeConnection tree)

Enable/disable oplock support

Specified by:

isOpLocksEnabled in interface OpLockInterface

Parameters:

sess - SrvSession

tree - TreeConnection

Returns:

boolean

buildPathForFileId

public String buildPathForFileId(SrvSession sess,
                        TreeConnection tree,
                        int dirid,
                        int fileid)
                          throws FileNotFoundException

Convert a file id to a share relative path

Specified by:

buildPathForFileId in interface FileIdInterface

Parameters:

sess - SrvSession

tree - TreeConnection

dirid - int

fileid - int

Returns:

String

Throws:

FileNotFoundException

hasSymbolicLinksEnabled

public boolean hasSymbolicLinksEnabled(SrvSession sess,
                              TreeConnection tree)

Determine if symbolic links are enabled

Specified by:

hasSymbolicLinksEnabled in interface SymbolicLinkInterface

Parameters:

sess - SrvSession

tree - TreeConnection

Returns:

boolean

readSymbolicLink

public String readSymbolicLink(SrvSession sess,
                      TreeConnection tree,
                      String path)
                        throws AccessDeniedException,
                               FileNotFoundException

Read the link data for a symbolic link

Specified by:

readSymbolicLink in interface SymbolicLinkInterface

Parameters:

sess - SrvSession

tree - TreeConnection

path - String

Returns:

String

Throws:

AccessDeniedException

FileNotFoundException

getSecurityDescriptorLength

public int getSecurityDescriptorLength(SrvSession sess,
                              TreeConnection tree,
                              NetworkFile netFile)
                                throws SMBSrvException

Return the security descriptor length for the specified file

Specified by:

getSecurityDescriptorLength in interface SecurityDescriptorInterface

Parameters:

sess - Server session

tree - Tree connection

netFile - Network file

Returns:

int

Throws:

SMBSrvException

loadSecurityDescriptor

public SecurityDescriptor loadSecurityDescriptor(SrvSession sess,
                                        TreeConnection tree,
                                        NetworkFile netFile)
                                          throws SMBSrvException

Load a security descriptor for the specified file

Specified by:

loadSecurityDescriptor in interface SecurityDescriptorInterface

Parameters:

sess - Server session

tree - Tree connection

netFile - Network file

Returns:

SecurityDescriptor

Throws:

SMBSrvException

saveSecurityDescriptor

public void saveSecurityDescriptor(SrvSession sess,
                          TreeConnection tree,
                          NetworkFile netFile,
                          SecurityDescriptor secDesc)
                            throws SMBSrvException

Save the security descriptor for the specified file

Specified by:

saveSecurityDescriptor in interface SecurityDescriptorInterface

Parameters:

sess - Server session

tree - Tree connection

netFile - Network file

secDesc - Security descriptor

Throws:

SMBSrvException