Package org.alfresco.repo.model.filefolder

Class FileFolderServiceImpl

    • Constructor Detail

      • FileFolderServiceImpl

        public FileFolderServiceImpl()
        Default constructor

    • Method Detail

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

      • 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()

      • 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

        public PagingResults<FileInfo> list​(NodeRef rootNodeRef,
                                    Set<QName> searchTypeQNames,
                                    Set<QName> ignoreAspectQNames,
                                    List<Pair<QName,​Boolean>> sortProps,
                                    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 PagingResults<FileInfo> list​(NodeRef rootNodeRef,
                                    Set<QName> assocTypeQNames,
                                    Set<QName> searchTypeQNames,
                                    Set<QName> ignoreAspectQNames,
                                    List<Pair<QName,​Boolean>> sortProps,
                                    List<FilterProp> filterProps,
                                    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(NodeRef, String, boolean, boolean, boolean)

      • 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

      • 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

      • 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