|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.filesys.alfresco.AlfrescoDiskDriver
org.alfresco.filesys.repo.ContentDiskDriver
public class ContentDiskDriver
Content repository filesystem driver class
Provides a filesystem interface for various protocols such as SMB/CIFS and FTP.
Field Summary | |
---|---|
static java.lang.String |
AttrLinkNode
|
static int |
CustomFileStatus
|
static int |
DeleteOnClose
|
static int |
DirectoryExists
|
static int |
FileExists
|
static int |
FileNotExist
|
static int |
FileRenamed
|
static int |
FileUnknown
|
Constructor Summary | |
---|---|
ContentDiskDriver(CifsHelper cifsHelper)
Class constructor |
Method Summary | |
---|---|
void |
closeFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
org.alfresco.jlan.server.filesys.NetworkFile file)
Close the file. |
org.alfresco.jlan.server.core.DeviceContext |
createContext(java.lang.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(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
org.alfresco.jlan.server.filesys.FileOpenParams params)
Create a new directory on this file system. |
org.alfresco.jlan.server.filesys.NetworkFile |
createFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
org.alfresco.jlan.server.filesys.FileOpenParams params)
Create a new file on the file system. |
void |
deleteDirectory(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
java.lang.String dir)
Delete the directory from the filesystem. |
void |
deleteFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
java.lang.String name)
Delete the specified file. |
int |
fileExists(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
java.lang.String name)
Check if the specified file exists, and whether it is a file or directory. |
void |
flushFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
org.alfresco.jlan.server.filesys.NetworkFile file)
Flush any buffered output for the specified file. |
AuthenticationContext |
getAuthenticationContext()
Return the authentication context |
AuthenticationService |
getAuthenticationService()
Return the authentication service |
CifsHelper |
getCifsHelper()
Return the CIFS helper |
ContentService |
getContentService()
Return the content service |
FileFolderService |
getFileFolderService()
Return the file folder service |
org.alfresco.jlan.server.filesys.FileInfo |
getFileInformation(org.alfresco.jlan.server.SrvSession session,
org.alfresco.jlan.server.filesys.TreeConnection tree,
java.lang.String path)
Get the file information for the specified file. |
org.alfresco.jlan.server.locking.LockManager |
getLockManager(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree)
Return the lock manager used by this filesystem |
LockService |
getLockService()
Return the lock service |
NamespaceService |
getNamespaceService()
Return the namespace service |
NodeArchiveService |
getNodeArchiveService()
Return the node archive service |
NodeRef |
getNodeForPath(org.alfresco.jlan.server.filesys.TreeConnection tree,
java.lang.String path)
Get the node for the specified path |
NodeService |
getNodeService()
Return the node service |
org.alfresco.jlan.server.locking.OpLockManager |
getOpLockManager(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree)
Return the oplock manager implementation associated with this virtual filesystem |
java.lang.String |
getPathForNode(org.alfresco.jlan.server.filesys.TreeConnection tree,
NodeRef nodeRef)
Convert a node into a share relative path |
PermissionService |
getPermissionService()
Return the permission service |
org.alfresco.jlan.server.filesys.pseudo.PseudoFileInterface |
getPseudoFileInterface(ContentContext context)
Return the pseudo file support implementation |
SearchService |
getSearchService()
Return the search service |
org.alfresco.jlan.server.filesys.cache.FileState |
getStateForPath(org.alfresco.jlan.server.filesys.TreeConnection tree,
java.lang.String path)
Get the file state for the specified path |
boolean |
hasPseudoFileInterface(ContentContext context)
Check if pseudo file support is enabled |
boolean |
isOpLocksEnabled(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree)
Enable/disable oplock support |
boolean |
isReadOnly(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.core.DeviceContext ctx)
Determine if the disk device is read-only. |
org.alfresco.jlan.server.filesys.NetworkFile |
openFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
org.alfresco.jlan.server.filesys.FileOpenParams params)
Open a file or folder |
int |
readFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
org.alfresco.jlan.server.filesys.NetworkFile file,
byte[] buffer,
int bufferPosition,
int size,
long fileOffset)
Read a block of data from the specified file. |
void |
registerContext(org.alfresco.jlan.server.core.DeviceContext ctx)
Registers a device context object for this instance of the shared device. |
void |
renameFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
java.lang.String oldName,
java.lang.String newName)
Rename the specified file. |
long |
seekFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
org.alfresco.jlan.server.filesys.NetworkFile file,
long pos,
int typ)
Seek to the specified file position. |
void |
setAuthenticationContext(AuthenticationContext authContext)
Set the authentication context |
void |
setAuthenticationService(AuthenticationService authService)
Set the authentication service |
void |
setContentService(ContentService contentService)
|
void |
setFileFolderService(FileFolderService fileService)
Set the file folder service |
void |
setFileInformation(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
java.lang.String name,
org.alfresco.jlan.server.filesys.FileInfo info)
Set file information |
void |
setLockService(LockService lockService)
Set the lock service |
void |
setMimetypeService(MimetypeService mimetypeService)
|
void |
setNamespaceService(NamespaceService namespaceService)
|
void |
setNodeArchiveService(NodeArchiveService nodeArchiveService)
Set the node archive service |
void |
setNodeMonitorFactory(NodeMonitorFactory nodeMonitorFactory)
Set the node monitor factory |
void |
setNodeService(NodeService nodeService)
|
void |
setPermissionService(PermissionService permissionService)
Set the permission service |
void |
setSearchService(SearchService searchService)
|
void |
setSysAdminParams(SysAdminParams sysAdminParams)
Sets the sys admin params. |
org.alfresco.jlan.server.filesys.SearchContext |
startSearch(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
java.lang.String searchPath,
int attributes)
Start a new search on the filesystem using the specified searchPath that may contain wildcards. |
void |
treeClosed(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree)
Connection opened to this disk device |
void |
treeOpened(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree)
Connection closed to this device |
void |
truncateFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
org.alfresco.jlan.server.filesys.NetworkFile file,
long size)
Truncate a file to the specified size |
int |
writeFile(org.alfresco.jlan.server.SrvSession sess,
org.alfresco.jlan.server.filesys.TreeConnection tree,
org.alfresco.jlan.server.filesys.NetworkFile file,
byte[] buffer,
int bufferOffset,
int size,
long fileOffset)
Write a block of data to the file. |
Methods inherited from class org.alfresco.filesys.alfresco.AlfrescoDiskDriver |
---|
beginReadTransaction, beginWriteTransaction, doInWriteTransaction, endTransaction, getServiceRegistry, getTransactionService, processIOControl, setServiceRegistry, setTransactionService |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int FileUnknown
public static final int FileNotExist
public static final int FileExists
public static final int DirectoryExists
public static final int CustomFileStatus
public static final int FileRenamed
public static final int DeleteOnClose
public static final java.lang.String AttrLinkNode
Constructor Detail |
---|
public ContentDiskDriver(CifsHelper cifsHelper)
serviceRegistry
- to connect to the repository servicesMethod Detail |
---|
public final CifsHelper getCifsHelper()
public final AuthenticationService getAuthenticationService()
public final AuthenticationContext getAuthenticationContext()
public final NodeService getNodeService()
public final ContentService getContentService()
public final NamespaceService getNamespaceService()
public final SearchService getSearchService()
public final FileFolderService getFileFolderService()
public final PermissionService getPermissionService()
public final NodeArchiveService getNodeArchiveService()
NodeArchiveService
- public final LockService getLockService()
public void setContentService(ContentService contentService)
contentService
- the content servicepublic void setNamespaceService(NamespaceService namespaceService)
namespaceService
- the namespace servicepublic void setNodeService(NodeService nodeService)
nodeService
- the node servicepublic void setSearchService(SearchService searchService)
searchService
- the search servicepublic void setPermissionService(PermissionService permissionService)
permissionService
- PermissionServicepublic void setAuthenticationContext(AuthenticationContext authContext)
authContext
- AuthenticationContextpublic void setAuthenticationService(AuthenticationService authService)
authService
- AuthenticationServicepublic void setSysAdminParams(SysAdminParams sysAdminParams)
sysAdminParams
- the sys admin paramspublic void setFileFolderService(FileFolderService fileService)
fileService
- FileFolderServicepublic void setMimetypeService(MimetypeService mimetypeService)
mimetypeService
- service for helping with mimetypes and encodingpublic void setNodeMonitorFactory(NodeMonitorFactory nodeMonitorFactory)
nodeMonitorFactory
- NodeMonitorFactorypublic void setNodeArchiveService(NodeArchiveService nodeArchiveService)
NodeArchiveService
- nodeArchiveServicepublic void setLockService(LockService lockService)
lockService
- LockServicepublic org.alfresco.jlan.server.core.DeviceContext createContext(java.lang.String shareName, org.springframework.extensions.config.ConfigElement cfg) throws org.alfresco.jlan.server.core.DeviceContextException
createContext
in interface org.alfresco.jlan.server.core.DeviceInterface
shareName
- Stringargs
- ConfigElement
org.alfresco.jlan.server.core.DeviceContextException
public void registerContext(org.alfresco.jlan.server.core.DeviceContext ctx) throws org.alfresco.jlan.server.core.DeviceContextException
registerContext
in interface ExtendedDiskInterface
registerContext
in class AlfrescoDiskDriver
ctx
- the context
org.alfresco.jlan.server.core.DeviceContextException
public final boolean hasPseudoFileInterface(ContentContext context)
context
- ContentContext
public final org.alfresco.jlan.server.filesys.pseudo.PseudoFileInterface getPseudoFileInterface(ContentContext context)
context
- ContentContext
public boolean isReadOnly(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.core.DeviceContext ctx) throws java.io.IOException
isReadOnly
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessionctx
- Device context
java.io.IOException
- If an error occurs.public org.alfresco.jlan.server.filesys.FileInfo getFileInformation(org.alfresco.jlan.server.SrvSession session, org.alfresco.jlan.server.filesys.TreeConnection tree, java.lang.String path) throws java.io.IOException
getFileInformation
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionname
- File name/path that information is required for.
java.io.IOException
- The exception description.public org.alfresco.jlan.server.filesys.SearchContext startSearch(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, java.lang.String searchPath, int attributes) throws java.io.FileNotFoundException
startSearch
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionsearchPath
- File(s) to search for, may include wildcards.attrib
- Attributes of the file(s) to search for, see class SMBFileAttribute.
java.io.FileNotFoundException
- If the search could not be started.public int fileExists(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, java.lang.String name)
fileExists
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionname
- java.lang.String
FileStatus
public org.alfresco.jlan.server.filesys.NetworkFile openFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, org.alfresco.jlan.server.filesys.FileOpenParams params) throws java.io.IOException
openFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- SrvSessiontree
- TreeConnectionparams
- FileOpenParams
java.io.IOException
public org.alfresco.jlan.server.filesys.NetworkFile createFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, org.alfresco.jlan.server.filesys.FileOpenParams params) throws java.io.IOException
createFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionparams
- File create parameters
java.io.IOException
- If an error occurs.public void createDirectory(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, org.alfresco.jlan.server.filesys.FileOpenParams params) throws java.io.IOException
createDirectory
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connection.params
- Directory create parameters
java.io.IOException
- If an error occurs.public void deleteDirectory(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, java.lang.String dir) throws java.io.IOException
deleteDirectory
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectiondir
- Directory name.
java.io.IOException
- The exception description.public void flushFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, org.alfresco.jlan.server.filesys.NetworkFile file) throws java.io.IOException
flushFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionfile
- Network file context.
java.io.IOException
- The exception description.public void closeFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, org.alfresco.jlan.server.filesys.NetworkFile file) throws java.io.IOException
closeFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connection.param
- Network file context.
java.io.IOException
- If an error occurs.public void deleteFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, java.lang.String name) throws java.io.IOException
deleteFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionfile
- NetworkFile
java.io.IOException
- The exception description.public void renameFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, java.lang.String oldName, java.lang.String newName) throws java.io.IOException
renameFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionoldName
- java.lang.StringnewName
- java.lang.String
java.io.IOException
- The exception description.public void setFileInformation(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, java.lang.String name, org.alfresco.jlan.server.filesys.FileInfo info) throws java.io.IOException
setFileInformation
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- SrvSessiontree
- TreeConnectionname
- Stringinfo
- FileInfo
java.io.IOException
public void truncateFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, org.alfresco.jlan.server.filesys.NetworkFile file, long size) throws java.io.IOException
truncateFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionfile
- Network file detailssize
- New file length
java.io.IOException
- The exception description.public int readFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, org.alfresco.jlan.server.filesys.NetworkFile file, byte[] buffer, int bufferPosition, int size, long fileOffset) throws java.io.IOException
readFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Session detailstree
- Tree connectionfile
- Network filebuf
- Buffer to return data tobufPos
- Starting position in the return buffersiz
- Maximum size of data to returnfilePos
- File offset to read data
java.io.IOException
- The exception description.public long seekFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, org.alfresco.jlan.server.filesys.NetworkFile file, long pos, int typ) throws java.io.IOException
seekFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionfile
- Network file.pos
- Position to seek to.typ
- Seek type.
java.io.IOException
public int writeFile(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree, org.alfresco.jlan.server.filesys.NetworkFile file, byte[] buffer, int bufferOffset, int size, long fileOffset) throws java.io.IOException
writeFile
in interface org.alfresco.jlan.server.filesys.DiskInterface
sess
- Server sessiontree
- Tree connectionfile
- Network file detailsbuf
- byte[] Data to be writtenbufoff
- Offset within the buffer that the data startssiz
- int Data lengthfileoff
- Position within the file that the data is to be written.
java.io.IOException
- The exception description.public NodeRef getNodeForPath(org.alfresco.jlan.server.filesys.TreeConnection tree, java.lang.String path) throws java.io.FileNotFoundException
tree
- TreeConnectionpath
- String
java.io.FileNotFoundException
public java.lang.String getPathForNode(org.alfresco.jlan.server.filesys.TreeConnection tree, NodeRef nodeRef) throws java.io.FileNotFoundException
tree
- TreeConnectionnodeRef
- NodeRef
java.io.FileNotFoundException
public org.alfresco.jlan.server.filesys.cache.FileState getStateForPath(org.alfresco.jlan.server.filesys.TreeConnection tree, java.lang.String path) throws java.io.FileNotFoundException
tree
- TreeConnectionpath
- String
java.io.FileNotFoundException
public void treeClosed(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree)
treeClosed
in interface org.alfresco.jlan.server.core.DeviceInterface
sess
- Server sessiontree
- Tree connectionpublic void treeOpened(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree)
treeOpened
in interface org.alfresco.jlan.server.core.DeviceInterface
sess
- Server sessiontree
- Tree connectionpublic org.alfresco.jlan.server.locking.LockManager getLockManager(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree)
getLockManager
in interface org.alfresco.jlan.server.locking.FileLockingInterface
sess
- SrvSessiontree
- TreeConnection
public org.alfresco.jlan.server.locking.OpLockManager getOpLockManager(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree)
getOpLockManager
in interface org.alfresco.jlan.server.locking.OpLockInterface
sess
- SrvSessiontree
- TreeConnection
public boolean isOpLocksEnabled(org.alfresco.jlan.server.SrvSession sess, org.alfresco.jlan.server.filesys.TreeConnection tree)
isOpLocksEnabled
in interface org.alfresco.jlan.server.locking.OpLockInterface
sess
- SrvSessiontree
- TreeConnection
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |