org.alfresco.filesys.avm

Class AVMDiskDriver

java.lang.Object

org.alfresco.filesys.alfresco.AlfrescoDiskDriver

org.alfresco.filesys.alfresco.AlfrescoTxDiskDriver

org.alfresco.filesys.avm.AVMDiskDriver

All Implemented Interfaces:

ExtendedDiskInterface, DeviceInterface, DiskInterface, IOCtlInterface, TransactionalFilesystemInterface

public class AVMDiskDriver
extends AlfrescoTxDiskDriver
implements DiskInterface

AVM Repository Filesystem Driver Class

Provides a filesystem interface for various protocols such as SMB/CIFS and FTP.

Author:

GKSpencer

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.filesys.alfresco.AlfrescoTxDiskDriver

AlfrescoTxDiskDriver.CallableIO<V>, AlfrescoTxDiskDriver.PropagatingException

Field Summary

Fields

Modifier and Type	Field and Description
static char	AVM_SEPERATOR
static String	AVM_SEPERATOR_STR
static int	CustomFileStatus
static int	DirectoryExists
static int	FileExists
static int	FileNotExist
static int	FileUnknown
static String	RoleContentManager
static String	RoleNotWebAuthor
static String	RoleWebProject

Fields inherited from class org.alfresco.filesys.alfresco.AlfrescoDiskDriver

ioControlHandler, m_transactionService

Constructor Summary

Constructors

Constructor and Description
AVMDiskDriver() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addNewStore(AVMContext avmCtx, String storeName) Add a new store to the top level folder list
protected AVMPath	buildStorePath(AVMContext ctx, String path, SrvSession sess) Build the full store path for a file/folder using the share relative path
void	closeFile(SrvSession sess, TreeConnection tree, NetworkFile file) Close the file.
DeviceContext	createContext(String shareName, org.springframework.extensions.config.ConfigElement cfg) Parse and validate the parameter string and create a device context object for this instance of the shared device.
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, String dir) Delete the directory from the filesystem.
void	deleteFile(SrvSession sess, TreeConnection tree, String name) Delete the specified file.
int	fileExists(SrvSession sess, TreeConnection tree, String name) Check if the specified file exists, and whether it is a file or directory.
protected FileState	findPseudoState(AVMPath avmPath, AVMContext avmCtx) Find the file state for a pseudo folder path
void	flushFile(SrvSession sess, TreeConnection tree, NetworkFile file) Flush any buffered output for the specified file.
AuthenticationService	getAuthenticationService() Return the authentication service
AVMService	getAvmService() Return the AVM service
StringList	getAVMStoreNames() Return a list of the available AVM store names
protected Map<org.alfresco.service.namespace.QName,PropertyValue>	getAVMStoreProperties(String storeName) Get the properties for a store
FileInfo	getFileInformation(SrvSession sess, TreeConnection tree, 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	registerContext(DeviceContext ctx) Register a device context object for this instance of the shared device.
void	renameFile(SrvSession sess, TreeConnection tree, String oldName, 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	setAuthenticationComponent(AuthenticationComponent authComponent) Set the authentication component
void	setAuthenticationService(AuthenticationService authService) Set the authentication service
void	setAvmService(AVMService avmService) Set the AVM service
void	setCreateStoreListener(CreateStoreTxnListener createStoreListener) Set the create store listener
void	setCreateVersionListener(CreateVersionTxnListener createVersionListener) Set the create version listener
void	setFileInformation(SrvSession sess, TreeConnection tree, String name, FileInfo info) Set the file information for the specified file.
void	setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService) Set the mimetype service
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set the node service
void	setPurgeStoreListener(PurgeStoreTxnListener purgeStoreListener) Set the purge store listener
void	setPurgeVersionListener(PurgeVersionTxnListener purgeVersionListener) Set the purge version listener
void	setWebProjectStore(String webStore) Set the web project store
SearchContext	startSearch(SrvSession sess, TreeConnection tree, String searchPath, int attrib) Start a new search on the filesystem using the specified searchPath that may contain wildcards.
void	treeClosed(SrvSession sess, TreeConnection tree) Connection opened to this disk device
void	treeOpened(SrvSession sess, TreeConnection tree) Connection closed to this 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 the file.

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

beginReadTransaction, beginWriteTransaction, doInWriteTransaction, endTransaction

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

getIoControlHandler, getServiceRegistry, getTransactionService, processIOControl, setIoControlHandler, setServiceRegistry, setTransactionService

Methods inherited from class java.lang.Object

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

Field Detail

AVM_SEPERATOR

public static final char AVM_SEPERATOR

See Also:

Constant Field Values

AVM_SEPERATOR_STR

public static final String AVM_SEPERATOR_STR

See Also:

Constant Field Values

RoleContentManager

public static final String RoleContentManager

See Also:

Constant Field Values

RoleWebProject

public static final String RoleWebProject

See Also:

Constant Field Values

RoleNotWebAuthor

public static final String RoleNotWebAuthor

See Also:

Constant Field Values

FileUnknown

public static final int FileUnknown

See Also:

Constant Field Values

FileNotExist

public static final int FileNotExist

See Also:

Constant Field Values

FileExists

public static final int FileExists

See Also:

Constant Field Values

DirectoryExists

public static final int DirectoryExists

See Also:

Constant Field Values

CustomFileStatus

public static final int CustomFileStatus

See Also:

Constant Field Values

Constructor Detail

AVMDiskDriver

public AVMDiskDriver()

Default constructor

Method Detail

getAvmService

public final AVMService getAvmService()

Return the AVM service

Returns:

AVMService

getAuthenticationService

public final AuthenticationService getAuthenticationService()

Return the authentication service

Returns:

AuthenticationService

setAvmService

public void setAvmService(AVMService avmService)

Set the AVM service

Parameters:

avmService - AVMService

setAuthenticationComponent

public void setAuthenticationComponent(AuthenticationComponent authComponent)

Set the authentication component

Parameters:

authComponent - AuthenticationComponent

setAuthenticationService

public void setAuthenticationService(AuthenticationService authService)

Set the authentication service

Parameters:

authService - AuthenticationService

setMimetypeService

public void setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)

Set the mimetype service

Parameters:

mimetypeService - MimetypeService

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Set the node service

Parameters:

nodeService - NodeService

setCreateStoreListener

public void setCreateStoreListener(CreateStoreTxnListener createStoreListener)

Set the create store listener

Parameters:

createStoreListener - CreateStoreTxnListener

setPurgeStoreListener

public void setPurgeStoreListener(PurgeStoreTxnListener purgeStoreListener)

Set the purge store listener

Parameters:

purgeStoreListener - PurgeStoreTxnListener

setCreateVersionListener

public void setCreateVersionListener(CreateVersionTxnListener createVersionListener)

Set the create version listener

Parameters:

createVersionListener - CreateVersionTxnListener

setPurgeVersionListener

public void setPurgeVersionListener(PurgeVersionTxnListener purgeVersionListener)

Set the purge version listener

Parameters:

purgeVersionListener - PurgeVersionTxnListener

setWebProjectStore

public void setWebProjectStore(String webStore)

Set the web project store

Parameters:

webStore - String

createContext

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

Parse and validate the parameter string and create a device context object for this instance of the shared device.

Specified by:

createContext in interface DeviceInterface

Parameters:

shareName - String

cfg - ConfigElement

Returns:

DeviceContext

Throws:

DeviceContextException

registerContext

public void registerContext(DeviceContext ctx)
                     throws DeviceContextException

Register a device context object for this instance of the shared device.

Specified by:

registerContext in interface ExtendedDiskInterface

Overrides:

registerContext in class AlfrescoDiskDriver

Parameters:

context - the device context

serverConfig - ServerConfigurationBean

Throws:

DeviceContextException

getAVMStoreNames

public final StringList getAVMStoreNames()

Return a list of the available AVM store names

Returns:

StringList

getAVMStoreProperties

protected final Map<org.alfresco.service.namespace.QName,PropertyValue> getAVMStoreProperties(String storeName)

Get the properties for a store

Parameters:

storeName - String

Returns:

Map

buildStorePath

protected final AVMPath buildStorePath(AVMContext ctx,
                     String path,
                     SrvSession sess)
                                throws AccessDeniedException

Build the full store path for a file/folder using the share relative path

Parameters:

ctx - AVMContext

path - String

sess - SrvSession

Returns:

AVMPath

Throws:

AccessDeniedException

closeFile

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

Close the file.

Specified by:

closeFile in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection.

file - Network file context.

Throws:

IOException - If an error occurs.

createDirectory

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

Create a new directory on this file system.

Specified by:

createDirectory in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection.

params - Directory create parameters

Throws:

IOException - If an error occurs.

createFile

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

Create a new file on the file system.

Specified by:

createFile in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

params - File create parameters

Returns:

NetworkFile

Throws:

IOException - If an error occurs.

deleteDirectory

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

Delete the directory from the filesystem.

Specified by:

deleteDirectory in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

dir - Directory name.

Throws:

IOException - The exception description.

deleteFile

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

Delete the specified file.

Specified by:

deleteFile in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

file - NetworkFile

Throws:

IOException - The exception description.

fileExists

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

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

Specified by:

fileExists in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

name - java.lang.String

Returns:

int

See Also:

FileStatus

flushFile

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

Flush any buffered output for the specified file.

Specified by:

flushFile in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

file - Network file context.

Throws:

IOException - The exception description.

getFileInformation

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

Get the file information for the specified file.

Specified by:

getFileInformation in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

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

Returns:

File information if valid, else null

Throws:

IOException - The exception description.

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 - Server session

ctx - Device context

Returns:

boolean

Throws:

IOException - If an error occurs.

openFile

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

Open a file on the file system.

Specified by:

openFile in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

params - File open parameters

Returns:

NetworkFile

Throws:

IOException - If an error occurs.

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 the specified 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 - The exception description.

renameFile

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

Rename the specified file.

Specified by:

renameFile in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

oldName - java.lang.String

newName - java.lang.String

Throws:

IOException - The exception description.

seekFile

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

Seek to the specified file position.

Specified by:

seekFile in interface DiskInterface

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:

IOException

setFileInformation

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

Set the file information for the specified file.

Specified by:

setFileInformation in interface DiskInterface

Parameters:

sess - Server session

tree - Tree connection

name - java.lang.String

info - FileInfo

Throws:

IOException - The exception description.

startSearch

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

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

Specified by:

startSearch in interface DiskInterface

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:

FileNotFoundException - If the search could not be started.

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 the file.

Specified by:

writeFile in interface DiskInterface

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:

IOException - The exception description.

treeClosed

public void treeClosed(SrvSession sess,
              TreeConnection tree)

Connection opened to this disk device

Specified by:

treeClosed in interface DeviceInterface

Parameters:

sess - Server session

tree - Tree connection

treeOpened

public void treeOpened(SrvSession sess,
              TreeConnection tree)

Connection closed to this device

Specified by:

treeOpened in interface DeviceInterface

Parameters:

sess - Server session

tree - Tree connection

findPseudoState

protected final FileState findPseudoState(AVMPath avmPath,
                        AVMContext avmCtx)

Find the file state for a pseudo folder path

Parameters:

avmPath - AVMPath

avmCtx - AVMContext

Returns:

FileState

addNewStore

protected void addNewStore(AVMContext avmCtx,
               String storeName)

Add a new store to the top level folder list

Parameters:

avmCtx - AVMContext

storeName - String