Package org.alfresco.repo.model.filefolder

Class FileFolderServiceImpl

java.lang.Object
org.alfresco.repo.copy.AbstractBaseCopyService
org.alfresco.repo.model.filefolder.FileFolderServiceImpl
All Implemented Interfaces:
FileFolderService, Extensible
public class FileFolderServiceImpl extends AbstractBaseCopyService implements FileFolderService, Extensible
Implementation of the file/folder-specific service.
Author:
Derek Hulley

  • Constructor Details

    • FileFolderServiceImpl

      public FileFolderServiceImpl()
      Default constructor

  • Method Details

    • setNamespaceService

      public void setNamespaceService(NamespaceService namespaceService)

    • setDictionaryService

      public void setDictionaryService(DictionaryService dictionaryService)

    • setNodeService

      public void setNodeService(NodeService nodeService)

    • setCopyService

      public void setCopyService(CopyService copyService)

    • setSearchService

      public void setSearchService(SearchService searchService)

    • setContentService

      public void setContentService(ContentService contentService)

    • setMimetypeService

      public void setMimetypeService(MimetypeService mimetypeService)

    • setHiddenAspect

      public void setHiddenAspect(HiddenAspect hiddenAspect)

    • setCannedQueryRegistry

      public void setCannedQueryRegistry(org.alfresco.util.registry.NamedObjectRegistry<org.alfresco.query.CannedQueryFactory<NodeRef>> cannedQueryRegistry)
      Set the registry of canned queries

    • setSystemPaths

      public void setSystemPaths(List<String> systemPaths)

    • setDefaultListMaxResults

      public void setDefaultListMaxResults(int defaultListMaxResults)

    • setBehaviourFilter

      public void setBehaviourFilter(BehaviourFilter behaviourFilter)

    • setPreserveAuditableData

      public void setPreserveAuditableData(boolean preserveAuditableData)

    • isPreserveAuditableData

      public boolean isPreserveAuditableData()

    • init

      public void init()

    • toFileInfoList

      public List<FileInfo> toFileInfoList(List<NodeRef> nodeRefs)
      Description copied from interface: FileFolderService
      Helper method to transform a list of NodeRef to a list of FileInfo
      Specified by:
      toFileInfoList in interface FileFolderService
      Returns:
      list of FileInfo

    • exists

      public boolean exists(NodeRef nodeRef)
      Description copied from interface: FileFolderService
      Check the validity of a node reference
      Specified by:
      exists in interface FileFolderService
      Returns:
      returns true if the NodeRef is valid

    • getType

      public FileFolderServiceType getType(QName typeQName)
      Description copied from interface: FileFolderService
      Checks the type for whether it is a recognised file or folder type or is invalid for the FileFolderService.
      Specified by:
      getType in interface FileFolderService
      Parameters:
      typeQName - the type to check
      Returns:
      - the type

    • list

      public List<FileInfo> list(NodeRef contextNodeRef)
      Description copied from interface: FileFolderService
      Lists immediate child files and folders of the given context node.

      Note: this could be a long list (and will be trimmed at a pre-configured maximum). You should consider using a paging request.

      Specified by:
      list in interface FileFolderService
      Parameters:
      contextNodeRef - the node to start searching in
      Returns:
      Returns a list of matching files and folders

    • list

      @Auditable(parameters={"contextNodeRef","files","folders","ignoreQNames","sortProps","pagingRequest"}) public org.alfresco.query.PagingResults<FileInfo> list(NodeRef contextNodeRef, boolean files, boolean folders, Set<QName> ignoreQNames, List<Pair<QName,Boolean>> sortProps, org.alfresco.query.PagingRequest pagingRequest)
      Description copied from interface: FileFolderService
      Lists page of immediate child files and/or folders of the given context node with optional filtering (exclusion of certain child file/folder subtypes) and sorting

      author janv
      Specified by:
      list in interface FileFolderService

    • list

      public org.alfresco.query.PagingResults<FileInfo> list(NodeRef contextNodeRef, boolean files, boolean folders, String pattern, Set<QName> ignoreQNames, List<Pair<QName,Boolean>> sortProps, org.alfresco.query.PagingRequest pagingRequest)
      Description copied from interface: FileFolderService
      Lists page of immediate child files and/or folders of the given context node with pattern matching and optional filtering (exclusion of certain child file/folder subtypes) and sorting Pattern uses '*' as a wildcard
      Specified by:
      list in interface FileFolderService

    • list

      public org.alfresco.query.PagingResults<FileInfo> list(NodeRef rootNodeRef, Set<QName> searchTypeQNames, Set<QName> ignoreAspectQNames, List<Pair<QName,Boolean>> sortProps, org.alfresco.query.PagingRequest pagingRequest)
      Description copied from interface: FileFolderService
      Lists page of immediate child objects of the given context node with specification of which types to list and optional filtering (exclusion of certain child file/folder subtypes) and sorting
      Specified by:
      list in interface FileFolderService
      Parameters:
      rootNodeRef - NodeRef
      searchTypeQNames - QNames of types to list
      pagingRequest - PagingRequest
      Returns:
      list of node refs, never null

    • list

      public org.alfresco.query.PagingResults<FileInfo> list(NodeRef rootNodeRef, Set<QName> assocTypeQNames, Set<QName> searchTypeQNames, Set<QName> ignoreAspectQNames, List<Pair<QName,Boolean>> sortProps, List<FilterProp> filterProps, org.alfresco.query.PagingRequest pagingRequest)
      Description copied from interface: FileFolderService
      Lists page of immediate child objects of the given context node with specification of which types to list and optional filtering (exclusion of certain child file/folder subtypes) and sorting
      Specified by:
      list in interface FileFolderService
      Parameters:
      rootNodeRef - NodeRef
      assocTypeQNames - QNames of assoc types to list
      searchTypeQNames - QNames of node types to list
      pagingRequest - PagingRequest
      Returns:
      list of node refs, never null

    • listFiles

      public List<FileInfo> listFiles(NodeRef contextNodeRef)
      Description copied from interface: FileFolderService
      Lists all immediate child files of the given context node Note: this could be a long list (and will be trimmed at a pre-configured maximum). You should consider using a paging request.
      Specified by:
      listFiles in interface FileFolderService
      Parameters:
      contextNodeRef - the folder nodeRef to start searching in
      Returns:
      Returns a list of matching files

    • listFolders

      public List<FileInfo> listFolders(NodeRef contextNodeRef)
      Description copied from interface: FileFolderService
      Lists all immediate child folders of the given context node Note: this could be a long list (and will be trimmed at a pre-configured maximum). You should consider using a paging request.
      Specified by:
      listFolders in interface FileFolderService
      Parameters:
      contextNodeRef - the node to start searching in
      Returns:
      Returns a list of matching folders

    • listDeepFolders

      public List<FileInfo> listDeepFolders(NodeRef contextNodeRef, SubFolderFilter filter)
      Description copied from interface: FileFolderService
      Lists all folders below the given context node, both immediate and lower levels The filter parameter allows subfolders to be excluded from the search.
      Specified by:
      listDeepFolders in interface FileFolderService
      Parameters:
      contextNodeRef - the node to start searching in
      filter - - may be null in which case all sub-folders will be searched

    • getLocalizedSibling

      public NodeRef getLocalizedSibling(NodeRef nodeRef)
      Description copied from interface: FileFolderService
      Uses the cm:name of the given node and attempts to find a sibling node with a more specific localized name. The node passed in must represent the base of the possible translations i.e. the base name for the resource names will be calculated using the filename without extension. The locale used will come from the thread's default locale.
      Specified by:
      getLocalizedSibling in interface FileFolderService
      Parameters:
      nodeRef - the node that acts as the baseline for the search
      Returns:
      Returns a sibling node or the original node

    • searchSimple

      public NodeRef searchSimple(NodeRef contextNodeRef, String name)
      Description copied from interface: FileFolderService
      Get a node ref of the node that has the name within the parent node
      Specified by:
      searchSimple in interface FileFolderService
      Parameters:
      contextNodeRef - the parent node
      name - the name of the node to search for
      Returns:
      Returns the node that has the given name - or null if not found

    • search

      public List<FileInfo> search(NodeRef contextNodeRef, String namePattern, boolean includeSubFolders)
      Description copied from interface: FileFolderService
      Searches for all files and folders with the matching name pattern, using wildcard characters * and ?. Warning: Please avoid using this method with any "namePattern" other than "*". Although it works, its performance is poor, which is why this method is deprecated.
      Specified by:
      search in interface FileFolderService
      Parameters:
      contextNodeRef - the context of the search. This node will never be returned as part of the search results.
      namePattern - the name of the file or folder to search for, or a wildcard pattern to search for.
      includeSubFolders - true to search the entire hierarchy below the search context
      Returns:
      Returns a list of file or folder matches
      See Also:

    • search

      public List<FileInfo> search(NodeRef contextNodeRef, String namePattern, boolean fileSearch, boolean folderSearch, boolean includeSubFolders)
      Full search with all options
      Specified by:
      search in interface FileFolderService
      Parameters:
      contextNodeRef - the context of the search. This node will never be returned as part of the search results.
      namePattern - the name of the file or folder to search for, or a wildcard pattern to search for.
      fileSearch - true if file types are to be included in the search results
      folderSearch - true if folder types are to be included in the search results
      includeSubFolders - true to search the entire hierarchy below the search context
      Returns:
      Returns a list of file or folder matches

    • rename

      public FileInfo rename(NodeRef sourceNodeRef, String newName) throws FileExistsException, FileNotFoundException
      Description copied from interface: FileFolderService
      Rename a file or folder in its current location
      Specified by:
      rename in interface FileFolderService
      Parameters:
      sourceNodeRef - the file or folder to rename
      newName - the new name
      Returns:
      Return the new file info
      Throws:
      FileExistsException - if a file or folder with the new name already exists
      FileNotFoundException - the file or folder reference doesn't exist
      See Also:

    • move

      public FileInfo move(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName) throws FileExistsException, FileNotFoundException
      Description copied from interface: FileFolderService
      Move a file or folder to a new name and/or location.

      If both the parent folder and name remain the same, then nothing is done.

      Specified by:
      move in interface FileFolderService
      Parameters:
      sourceNodeRef - the file or folder to move
      targetParentRef - the new parent node to move the node to - null means rename in situ
      newName - the name to change the file or folder to - null to keep the existing name
      Returns:
      Returns the new file info
      Throws:
      FileExistsException
      FileNotFoundException
      See Also:
      • moveOrCopy(NodeRef, NodeRef, NodeRef, String, boolean)

    • moveFrom

      public FileInfo moveFrom(NodeRef sourceNodeRef, NodeRef sourceParentRef, NodeRef targetParentRef, String newName) throws FileExistsException, FileNotFoundException
      Description copied from interface: FileFolderService
      Move a file or folder to a new name and/or location.

      If both the parent folder and name remain the same, then nothing is done.

      It is possible to specify which is the parent node when moving nodes; nodes can reside in multiple locations.

      Specified by:
      moveFrom in interface FileFolderService
      Parameters:
      sourceNodeRef - the file or folder to move
      sourceParentRef - the source parent of node - null means move from primary parent
      targetParentRef - the new parent node to move the node to - null means rename in situ
      newName - the name to change the file or folder to - null to keep the existing name
      Returns:
      Returns the new file info
      Throws:
      FileExistsException
      FileNotFoundException
      See Also:
      • moveOrCopy(NodeRef, NodeRef, NodeRef, String, boolean)

    • move

      public FileInfo move(NodeRef sourceNodeRef, NodeRef sourceParentRef, NodeRef targetParentRef, String newName) throws FileExistsException, FileNotFoundException
      Deprecated.
      Specified by:
      move in interface FileFolderService
      Throws:
      FileExistsException
      FileNotFoundException

    • copy

      public FileInfo copy(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName) throws FileExistsException, FileNotFoundException
      Description copied from interface: FileFolderService
      Copy a source file or folder. The source can be optionally renamed and optionally moved into another folder.

      If both the parent folder and name remain the same, then nothing is done.

      Specified by:
      copy in interface FileFolderService
      Parameters:
      sourceNodeRef - the file or folder to copy
      targetParentRef - the new parent node to copy the node to - null means rename in situ
      newName - the new name, or null to keep the existing name.
      Returns:
      Return the new file info
      Throws:
      FileExistsException
      FileNotFoundException
      See Also:
      • moveOrCopy(NodeRef, NodeRef, NodeRef, String, boolean)

    • create

      public FileInfo create(NodeRef parentNodeRef, String name, QName typeQName) throws FileExistsException
      Description copied from interface: FileFolderService
      Create a file or folder; or any valid node of type derived from file or folder.

      The association QName for the patch defaults to cm:filename i.e. the Content Model namespace with the filename as the local name.

      Specified by:
      create in interface FileFolderService
      Parameters:
      parentNodeRef - the parent node. The parent must be a valid folder.
      name - the name of the node
      typeQName - the type to create
      Returns:
      Returns the new node's file information
      Throws:
      FileExistsException

    • create

      public FileInfo create(NodeRef parentNodeRef, String name, QName typeQName, QName assocQName) throws FileExistsException
      Description copied from interface: FileFolderService
      Create a file or folder; or any valid node of type derived from file or folder
      Specified by:
      create in interface FileFolderService
      Parameters:
      parentNodeRef - the parent node. The parent must be a valid folder.
      name - the name of the node
      typeQName - the type to create
      assocQName - the association QName to set for the path (may be null).
      Returns:
      Returns the new node's file information
      Throws:
      FileExistsException

    • delete

      public void delete(NodeRef nodeRef)
      Description copied from interface: FileFolderService
      Delete a file or folder
      Specified by:
      delete in interface FileFolderService
      Parameters:
      nodeRef - the node to delete

    • makeFolders

      public FileInfo makeFolders(NodeRef parentNodeRef, List<String> pathElements, QName folderTypeQName)
      Deprecated.
      Use FileFolderUtil.makeFolders rather than directly accessing this implementation class.
      Checks for the presence of, and creates as necessary, the folder structure in the provided path.

      An empty path list is not allowed as it would be impossible to necessarily return file info for the parent node - it might not be a folder node.

      Parameters:
      parentNodeRef - the node under which the path will be created
      pathElements - the folder name path to create - may not be empty
      folderTypeQName - the types of nodes to create. This must be a valid subtype of they folder type.
      Returns:
      Returns the info of the last folder in the path.

    • makeFolders

      public static FileInfo makeFolders(FileFolderService service, NodeRef parentNodeRef, List<String> pathElements, QName folderTypeQName)
      Deprecated.
      Use FileFolderUtil.makeFolders rather than directly accessing this implementation class.
      Checks for the presence of, and creates as necessary, the folder structure in the provided path.

      An empty path list is not allowed as it would be impossible to necessarily return file info for the parent node - it might not be a folder node.

      Parameters:
      parentNodeRef - the node under which the path will be created
      pathElements - the folder name path to create - may not be empty
      folderTypeQName - the types of nodes to create. This must be a valid subtype of they folder type.
      Returns:
      Returns the info of the last folder in the path.

    • getNamePath

      public List<FileInfo> getNamePath(NodeRef rootNodeRef, NodeRef nodeRef) throws FileNotFoundException
      Get the file or folder information from the root down to and including the node provided.
      • The root node can be of any type and is not included in the path list.
      • Only the primary path is considered. If the target node is not a descendant of the root along purely primary associations, then an exception is generated.
      • If an invalid type is encountered along the path, then an exception is generated.
      Specified by:
      getNamePath in interface FileFolderService
      Parameters:
      rootNodeRef - the start of the returned path, or null if the store root node must be assumed.
      nodeRef - a reference to the file or folder
      Returns:
      Returns a list of file/folder infos from the root (excluded) down to and including the destination file or folder
      Throws:
      FileNotFoundException - if the node could not be found

    • getNameOnlyPath

      public List<String> getNameOnlyPath(NodeRef rootNodeRef, NodeRef nodeRef) throws FileNotFoundException
      Get the file or folder names from the root down to and including the node provided.
      • The root node can be of any type and is not included in the path list.
      • Only the primary path is considered. If the target node is not a descendant of the root along purely primary associations, then an exception is generated.
      • If an invalid type is encountered along the path, then an exception is generated.
      Specified by:
      getNameOnlyPath in interface FileFolderService
      Parameters:
      rootNodeRef - the start of the returned path, or null if the store root node must be assumed.
      nodeRef - a reference to the file or folder
      Returns:
      Returns a list of file/folder names from the root (excluded) down to and including the destination file or folder
      Throws:
      FileNotFoundException - if the node could not be found

    • resolveNamePath

      public FileInfo resolveNamePath(NodeRef rootNodeRef, List<String> pathElements) throws FileNotFoundException
      Description copied from interface: FileFolderService
      Resolve a file or folder name path from a given root node down to the final node.
      Specified by:
      resolveNamePath in interface FileFolderService
      Parameters:
      rootNodeRef - the start point node - a cm:folder type or subtype, e.g. the Company Home's nodeRef
      pathElements - a list of names in the path. Do not include the referenced rootNodeRef's path element.
      Returns:
      Returns the info of the file or folder
      Throws:
      FileNotFoundException - if no file or folder exists along the path

    • resolveNamePath

      public FileInfo resolveNamePath(NodeRef rootNodeRef, List<String> pathElements, boolean mustExist) throws FileNotFoundException
      Description copied from interface: FileFolderService
      Resolve a file or folder name path from a given root node down to the final node.
      Specified by:
      resolveNamePath in interface FileFolderService
      Parameters:
      rootNodeRef - the start point node - a cm:folder type or subtype, e.g. the Company Home's nodeRef
      pathElements - a list of names in the path. Do not include the referenced rootNodeRef's path element.
      Returns:
      Returns the info of the file or folder or null if mustExist is false and the file does not exist
      Throws:
      FileNotFoundException - if no file or folder exists along the path and mustExist is true

    • getFileInfo

      public FileInfo getFileInfo(NodeRef nodeRef)
      Description copied from interface: FileFolderService
      Get the file info (name, folder, etc) for the given node
      Specified by:
      getFileInfo in interface FileFolderService
      Parameters:
      nodeRef - the node to get info for
      Returns:
      Returns the file info or null if the node does not represent a file or folder

    • getReader

      public ContentReader getReader(NodeRef nodeRef)
      Description copied from interface: FileFolderService
      Get the reader to the file represented by the node according to the File/Folder model. (This is not the same as the method on the ContentService)
      Specified by:
      getReader in interface FileFolderService
      Parameters:
      nodeRef - the content node
      Returns:
      Returns a handle to the content associated with the node

    • getWriter

      public ContentWriter getWriter(NodeRef nodeRef)
      Description copied from interface: FileFolderService
      Get the writer to the file represented by the node according to the File/Folder model. (This is not the same as the method on the ContentService)
      Specified by:
      getWriter in interface FileFolderService
      Parameters:
      nodeRef - the content node
      Returns:
      Returns a handle to the content associated with the node

    • setHidden

      public void setHidden(NodeRef nodeRef, boolean isHidden)
      Specified by:
      setHidden in interface FileFolderService

    • isHidden

      public boolean isHidden(NodeRef nodeRef)
      Specified by:
      isHidden in interface FileFolderService

    • getTrait

      public <M extends Trait> ExtendedTrait<M> getTrait(Class<? extends M> traitAPI)
      Specified by:
      getTrait in interface Extensible