org.alfresco.filesys.repo

Class CifsHelper

java.lang.Object

org.alfresco.filesys.repo.CifsHelper

public class CifsHelper
extends Object

Class with supplying helper methods and potentially acting as a cache for queries.

Author:

derekh

Constructor Summary

Constructors

Constructor and Description
CifsHelper() Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
org.alfresco.service.cmr.repository.NodeRef	createNode(org.alfresco.service.cmr.repository.NodeRef rootNodeRef, String path, org.alfresco.service.namespace.QName typeQName) Creates a file or directory using the given paths.
ContentFileInfo	getFileInformation(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean readOnly, boolean lockedFilesAsOffline)
ContentFileInfo	getFileInformation(org.alfresco.service.cmr.repository.NodeRef pathRootNodeRef, String path, boolean readOnly, boolean lockedFilesAsOffline) Extract a single node's file info, where the node is reference by a path relative to an ancestor node.
ContentFileInfo	getFileInformationImpl(org.alfresco.service.cmr.repository.NodeRef pathRootNodeRef, String path, boolean readOnly, boolean lockedFilesAsOffline) Extract a single node's file info, where the node is reference by a path relative to an ancestor node.
String	getFileName(org.alfresco.service.cmr.repository.NodeRef nodeRef) Return the file name for a node
String	getFileNameImpl(org.alfresco.service.cmr.repository.NodeRef node) Return the file name for a node
LockService	getLockService()
org.alfresco.service.cmr.repository.NodeRef	getNodeRef(org.alfresco.service.cmr.repository.NodeRef pathRootNodeRef, String path) Attempts to fetch a specific single node at the given path.
List<org.alfresco.service.cmr.repository.NodeRef>	getNodeRefs(org.alfresco.service.cmr.repository.NodeRef pathRootNodeRef, String path) Finds the nodes being reference by the given directory and file paths.
protected org.alfresco.service.cmr.repository.NodeService	getNodeService() Return the node service
RetryingTransactionHelper	getRetryingTransactionHelper()
void	init()
boolean	isDirectory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
boolean	isFolderEmpty(org.alfresco.service.cmr.repository.NodeRef folderNode) Check if the folder node is empty
void	move(org.alfresco.service.cmr.repository.NodeRef nodeToMoveRef, org.alfresco.service.cmr.repository.NodeRef oldParent, org.alfresco.service.cmr.repository.NodeRef newParentNodeRef, String newName) Deprecated. - not used by live code - exception handling is too severe
void	relinkNode(org.alfresco.service.cmr.repository.NodeRef tempNodeRef, org.alfresco.service.cmr.repository.NodeRef nodeToMoveRef, org.alfresco.service.cmr.repository.NodeRef newParentNodeRef, String newName) Relink the content data from a new node to an existing node to preserve the version history.
void	rename(org.alfresco.service.cmr.repository.NodeRef nodeToRenameRef, String newName) Deprecated. - not used by live code - exception handling is too severe
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setExcludedTypes(List<String> excludedTypes)
void	setFileFolderService(FileFolderService fileFolderService)
void	setHiddenAspect(HiddenAspect hiddenAspect)
void	setLockService(LockService lockService)
void	setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
void	setReadOnlyFlagOnFolders(boolean setReadOnlyFlagOnFolders) Controls whether the read only flag is set on folders.
void	setRetryingTransactionHelper(RetryingTransactionHelper retryingTransactionHelper)

Methods inherited from class java.lang.Object

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

Constructor Detail

CifsHelper

public CifsHelper()

Class constructor

Method Detail

init

public void init()

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setNodeService

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

setFileFolderService

public void setFileFolderService(FileFolderService fileFolderService)

setMimetypeService

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

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

setHiddenAspect

public void setHiddenAspect(HiddenAspect hiddenAspect)

getNodeService

protected org.alfresco.service.cmr.repository.NodeService getNodeService()

Return the node service

Returns:

NodeService

setExcludedTypes

public void setExcludedTypes(List<String> excludedTypes)

setReadOnlyFlagOnFolders

public void setReadOnlyFlagOnFolders(boolean setReadOnlyFlagOnFolders)

Controls whether the read only flag is set on folders. This flag, when set, may cause problematic # behaviour in Windows clients and doesn't necessarily mean a folder can't be written to. See ALF-6727. Should we ever set the read only flag on folders?

Parameters:

setReadOnlyFlagOnFolders - the setReadOnlyFlagOnFolders to set

isDirectory

public boolean isDirectory(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Parameters:

serviceRegistry - for repo connection

nodeRef -

Returns:

Returns true if the node is a subtype of folder

Throws:

org.alfresco.error.AlfrescoRuntimeException - if the type is neither related to a folder or content

getFileInformation

public ContentFileInfo getFileInformation(org.alfresco.service.cmr.repository.NodeRef pathRootNodeRef,
                                 String path,
                                 boolean readOnly,
                                 boolean lockedFilesAsOffline)
                                   throws FileNotFoundException

Extract a single node's file info, where the node is reference by a path relative to an ancestor node.

Parameters:

pathRootNodeRef -

path - the path

Returns:

Returns the existing node reference

Throws:

FileNotFoundException

getFileInformation

public ContentFileInfo getFileInformation(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                 boolean readOnly,
                                 boolean lockedFilesAsOffline)
                                   throws FileNotFoundException

Throws:

FileNotFoundException

getFileInformationImpl

public ContentFileInfo getFileInformationImpl(org.alfresco.service.cmr.repository.NodeRef pathRootNodeRef,
                                     String path,
                                     boolean readOnly,
                                     boolean lockedFilesAsOffline)
                                       throws FileNotFoundException

Extract a single node's file info, where the node is reference by a path relative to an ancestor node.

Parameters:

pathRootNodeRef -

path - the path

Returns:

Returns the existing node reference

Throws:

FileNotFoundException

createNode

public org.alfresco.service.cmr.repository.NodeRef createNode(org.alfresco.service.cmr.repository.NodeRef rootNodeRef,
                                                     String path,
                                                     org.alfresco.service.namespace.QName typeQName)
                                                       throws FileExistsException

Creates a file or directory using the given paths.

If the directory path doesn't exist, then all the parent directories will be created. If the file path is null, then the file will not be created

Parameters:

rootNodeRef - the root node of the path

path - the path to a node

isFile - true if the node to be created must be a file

Returns:

Returns a newly created file or folder node

Throws:

FileExistsException - if the file or folder already exists

getNodeRefs

public List<org.alfresco.service.cmr.repository.NodeRef> getNodeRefs(org.alfresco.service.cmr.repository.NodeRef pathRootNodeRef,
                                                            String path)

Finds the nodes being reference by the given directory and file paths.

Examples of the path are:

• \New Folder\New Text Document.txt
• \New Folder\Sub Folder

Parameters:

searchRootNodeRef - the node from which to start the path search

path - the search path to either a folder or file

Returns:

Returns references to all matching nodes

getNodeRef

public org.alfresco.service.cmr.repository.NodeRef getNodeRef(org.alfresco.service.cmr.repository.NodeRef pathRootNodeRef,
                                                     String path)
                                                       throws FileNotFoundException

Attempts to fetch a specific single node at the given path.

The path may contain wild cards

Throws:

FileNotFoundException - if the path can't be resolved to a node

See Also:

getNodeRefs(NodeRef, String)

relinkNode

public void relinkNode(org.alfresco.service.cmr.repository.NodeRef tempNodeRef,
              org.alfresco.service.cmr.repository.NodeRef nodeToMoveRef,
              org.alfresco.service.cmr.repository.NodeRef newParentNodeRef,
              String newName)
                throws FileNotFoundException,
                       FileExistsException

Relink the content data from a new node to an existing node to preserve the version history.

Parameters:

oldNodeRef - NodeRef

newNodeRef - NodeRef

Throws:

FileNotFoundException

FileExistsException

move

public void move(org.alfresco.service.cmr.repository.NodeRef nodeToMoveRef,
        org.alfresco.service.cmr.repository.NodeRef oldParent,
        org.alfresco.service.cmr.repository.NodeRef newParentNodeRef,
        String newName)
          throws FileExistsException

Deprecated. - not used by live code - exception handling is too severe

Move a node

Parameters:

nodeToMoveRef - Node to be moved

newParentNodeRef - New parent folder node

newName - New name for the moved node

Throws:

FileExistsException

rename

public void rename(org.alfresco.service.cmr.repository.NodeRef nodeToRenameRef,
          String newName)
            throws FileExistsException

Deprecated. - not used by live code - exception handling is too severe

Rename a node

Parameters:

nodeToRenameRef - Node to be renamed

newName - New name for the node

Throws:

FileExistsException

getFileName

public String getFileName(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Return the file name for a node

Parameters:

nodeRef - NodeRef of node to get the file name

Returns:

String or null if the nodeRef is not valid

getFileNameImpl

public String getFileNameImpl(org.alfresco.service.cmr.repository.NodeRef node)

Return the file name for a node

Parameters:

node - NodeRef

Returns:

String

Throws:

FileNotFoundException

isFolderEmpty

public boolean isFolderEmpty(org.alfresco.service.cmr.repository.NodeRef folderNode)

Check if the folder node is empty

Parameters:

folderNode - NodeRef

Returns:

boolean

setLockService

public void setLockService(LockService lockService)

getLockService

public LockService getLockService()

setRetryingTransactionHelper

public void setRetryingTransactionHelper(RetryingTransactionHelper retryingTransactionHelper)

getRetryingTransactionHelper

public RetryingTransactionHelper getRetryingTransactionHelper()