mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-07 18:25:23 +00:00
20167: Merged HEAD to BRANCHES/V3.3: (RECORD ONLY) 20166: Fix ALF-2765: Renditions created via 3.3 RenditionService are not exposed via OpenCMIS rendition API 20232: Fix problem opening AVM web project folders via FTP. ALF-2738. 20234: ALF-2352: Cannot create folders in Share doclib without admin user in authentication chain 20235: Fix for unable to create folders in web project via CIFS. ALF-2736. 20258: Reverse-merged rev 20254: 'When dropping the mysql database ...' 20262: Merged V3.3-BUG-FIX to V3.3 20251: Fix for ALF-2804 - Unable to browse into folders in Share Site in certain situations. - Browser history filter object in incorrect state after page refresh. 20264: Updated Oracle build support (to fix grants) 20282: Merged PATCHES/V3.2.0 to V3.3 20266: Test reproduction of ALF-2839 failure: Node pre-loading generates needless resultset rows 20280: Fixed ALF-2839: Node pre-loading generates needless resultset rows 20283: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: 20194: AVMTestSuite - scale down unit tests (slightly) 20247: AVMServiceTest.testVersionByDate - build (add delay) 20290: Fixed ALF-2851 "Drag n Drop issues in IE6 & IE7" - Reordering rules-list with drag and drop didn't work at all because each rule was created using a template that had the "id"-attribute set, which made IE confused after using HTMLELement.clone() even though the id was resetted - Both customise-dashlets & rules-list got an error when "throwing" away the dashlet or rule instead of releasing it "carefully", reason was becuuase IE didnt capture the x:y-position which made the animation fail. Now no animation is done if x:y isn't found. 20296: Merged PATCHES/V3.1.0 to V3.3 (RECORD ONLY) 20249: Merged V3.1 to PATCHES/V3.1.0 14565: Updated version to include revision number (x.y.z) 20246: Merged V3.1 to PATCHES/V3.1.0 13841: Build fix 20245: Merged V3.1 to PATCHES/V3.1.0 16185: AbstractLuceneIndexerAndSearcherFactory.getTransactionId() must return null when there is no transaction 20241: Merged V3.1 to PATCHES/V3.1.0 14187: Fix for ETHREEOH-2023: LDAP import must lower case the local name of the association to person. 16167: ETHREEOH-2475: Fixed nested transaction handling in AbstractLuceneIndexerAndSearcherFactory to allow duplicate user processing in PersonServiceImpl to actually work 16168: ETHREEOH-2797: Force patch.db-V2.2-Person to apply one more time to fix up corrupt users created by LDAP Import - Problem due to ETHREEOH-2023, fixed in 3.1.1 - Also corrects ldap.synchronisation.defaultHomeFolderProvider to be userHomesHomeFolderProvider - Also requires fix to ETHREEOH-2475 to fix up duplicate users 20221:Merged PATCHES/V3.1.2 to PATCHES/V3.1.0 20217: Merged PATCHES/V3.2.0 to PATCHES/V3.1.2 19793: Merged HEAD to V3.2.0 19786: Refactor of previous test fix. I have pushed down the OOo-specific parts of the change from AbstractContentTransformerTest to OpenOfficeContentTransformerTest leaving an extension point in the base class should other transformations need to be excluded in the future. 19785: Fix for failing test OpenOfficeContentTransformerTest.testAllConversions. Various OOo-related transformations are returned as available but fail on our test server with OOo on it. Pending further work on these failings, I am disabling those transformations in test code whilst leaving them available in the product code. This is because in the wild a different OOo version may succeed with these transformations. I had previously explicitly disabled 3 transformations in the product and I am moving that restriction from product to test code for the same reason. 19707: Return value from isTransformationBlocked was inverted. Fixed now. 19705: Refinement of previous check-in re OOo transformations. I have pulled up the code that handles blocked transformations into a superclass so that the JodConverter-based transformer worker can inherit the same list of blocked transformations. To reiterate, blocked transformations are those that the OOo integration code believes should work but which are broken in practice. These are blocked by the transformers and will always be unavailable regardless of the OOo connection state. 19702: Fix for HEAD builds running on panda build server. OOo was recently installed on panda which has activated various OOo-related transformations/extractions in the test code. It appears that OOo does not support some transformations from Office 97 to Office 2007. Specifically doc to docx and xls to xlsx. These transformations have now been marked as unavailable. 20220: Created hotfix branch off TAGS/ENTERPRISE/V3.1.0 20297: Merged PATCHES/V3.1.2 to V3.3 (RECORD ONLY) 20268: Increment version number 20267: ALF-550: Merged V3.2 to PATCHES/V3.1.2 17768: Merged DEV/BELARUS/V3.2-2009_11_24 to V3.2 17758: ETHREEOH-3757: Oracle upgrade issue: failed "inviteEmailTemplate" patch - also causes subsequent patches to not be applied 20217: Merged PATCHES/V3.2.0 to PATCHES/V3.1.2 19793: Merged HEAD to V3.2.0 19786: Refactor of previous test fix. I have pushed down the OOo-specific parts of the change from AbstractContentTransformerTest to OpenOfficeContentTransformerTest leaving an extension point in the base class should other transformations need to be excluded in the future. 19785: Fix for failing test OpenOfficeContentTransformerTest.testAllConversions. Various OOo-related transformations are returned as available but fail on our test server with OOo on it. Pending further work on these failings, I am disabling those transformations in test code whilst leaving them available in the product code. This is because in the wild a different OOo version may succeed with these transformations. I had previously explicitly disabled 3 transformations in the product and I am moving that restriction from product to test code for the same reason. 19707: Return value from isTransformationBlocked was inverted. Fixed now. 19705: Refinement of previous check-in re OOo transformations. I have pulled up the code that handles blocked transformations into a superclass so that the JodConverter-based transformer worker can inherit the same list of blocked transformations. To reiterate, blocked transformations are those that the OOo integration code believes should work but which are broken in practice. These are blocked by the transformers and will always be unavailable regardless of the OOo connection state. 19702: Fix for HEAD builds running on panda build server. OOo was recently installed on panda which has activated various OOo-related transformations/extractions in the test code. It appears that OOo does not support some transformations from Office 97 to Office 2007. Specifically doc to docx and xls to xlsx. These transformations have now been marked as unavailable. 20204: Moved version label to '.6' 20298: Merged PATCHES/V3.2.0 to V3.3 (RECORD ONLY) 20281: Incremented version number to '10' 20272: Backports to help fix ALF-2839: Node pre-loading generates needless resultset rows Merged BRANCHES/V3.2 to PATCHES/V3.2.0: 18490: Added cache for alf_content_data Merged BRANCHES/DEV/V3.3-BUG-FIX to PATCHES/V3.2.0: 20231: Fixed ALF-2784: Degradation of performance between 3.1.1 and 3.2x (observed in JSF) 20299: Merged PATCHES/V3.2.1 to V3.3 (RECORD ONLY) 20279: Incremented version label 20211: Reinstated patch 'patch.convertContentUrls' (reversed rev 20205 ALF-2719) 20210: Incremented version label to '.3' 20206: Bumped version label to '.2' 20205: Workaround for ALF-2719 by disabling patch.convertContentUrls and ContentStoreCleaner 20149: Incremented version label 20101: Created hotfix branch off ENTERPRISE/V3.2.1 20300: Merged BRANCHES/DEV/BELARUS/HEAD-2010_04_28 to BRANCHES/V3.3: 20293: ALF-767: remove-AVM-issuer.sql upgrade does not account for column (mis-)order - fixed for MySQL, PostgreSQL and Oracle (DB2 & MS SQL Server already OK) 20301: Merged PATCHES/V3.2.1 to V3.3 20278: ALF-206: Make it possible to follow hyperlinks to document JSF client URLs from MS Office - A request parameter rather than a (potentially forgotten) session attribute is used to propagate the URL to redirect to after successful login 20303: Fixed ALF-2855: FixAuthorityCrcValuesPatch reports NPE during upgrade from 2.1.7 to 3.3E - Auto-unbox NPE on Long->long: Just used the Long directly for reporting 20319: Fixed ALF-2854: User Usage Queries use read-write methods on QNameDAO 20322: Fixed ALF-1998: contentStoreCleanerJob leads to foreign key exception - Possible concurrent modification of alf_content_url.orphan_time led to false orphan detection - Fixed queries to check for dereferencing AND use the indexed orphan_time column - More robust use of EagerContentStoreCleaner: On eager cleanup, ensure that URLs are deleted - Added optimistic lock checks on updates and deletes of alf_content_url 20335: Merged DEV/V3.3-BUG-FIX to V3.3 20334: ALF-2473: Changes for clean startup and shutdown of subsystems on Spring 3 - Removed previous SafeEventPublisher workaround for startup errors and associated changes - Replaced with SafeApplicationEventMulticaster which queues up events while an application context isn't started - Now all subsystems shut down cleanly - Fixes problem with FileContentStore visibility in JMX too! 20341: ALF-2517 Quick fix which means rules which compare the creation/modification date of content should now correctly be applied when content is uploaded to a folder. 20346: ALF-2839: Node pre-loading generates needless resultset rows - Added missing Criteria.list() call 20347: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: 20231: Fixed ALF-2784: Degradation of performance between 3.1.1 and 3.2x (observed in JSF) 20356: Merged DEV/BELARUS/HEAD-2010_03_30 to V3.3 (with corrections) 19735: ALF-686: Alfresco cannot start if read/write mode in Sysadmin subsystem is configured 1. org.alfresco.repo.module.ModuleComponentHelper was modified to allow “System” user run write operations in read-only system. 2. Startup of “Synchronization” subsystem failed with the same error as was occurred in issue during modules start. org.alfresco.repo.security.sync.ChainingUserRegistrySynchronizer was also modified to allow “System” user run write operations in read-only mode. 20361: Merged HEAD to BRANCHES/V3.3: (RECORD ONLY) 20345: Fix ALF-2319: CMIS 'current' version mapping is not compliant with spec 20354: Update test to reflect changes to CMIS version mapping. 20363: Merge from V3.2 to V3.2 (all record-only) c. 19448 OOoJodConverter worker bean correctly handles isAvailable() when subsystem is disabled. c. 19484 JodConverter-backed thumbnailing test now explicitly sets OOoDirect and OOoJodconverter enabled-ness back to default settings in tearDown c. 20175 Fix for ALF-2773 JMX configuration of enterprise logging broken 20376: Altered URL of online help to point at http://www.alfresco.com/help/33/enterprise/webeditor/ 20395: set google docs off 20398: Fixed ALF-2890: Upgrade removes content if transaction retries are triggered - Setting ContentData that was derived outside of the current transaction opened up a window for the post-rollback code to delete the underlying binary. The binaries are only registered for writers fetched via the ContentService now; the low-level DAO no longer does management because it can't assume that a new content URL indicates a new underlying binary. - The contentUrlConverter was creating new URLs and thus the low-level DAO cleaned up live content when retrying collisions took place. The cleanup is no longer on the stack for the patch. - Removes the ALF-558 changes around ContentData.reference() 20399: Remove googledocs aspect option 20400: PurgeTestP (AVM) - increase wait cycles 20422: Added ooo converter properties 20425: Merge V3.3-BUG-FIX to V3.3 20392 : ALF-2716 - imap mail metadata extraction fails when alfresco server locale is non English 20365 : Merge DEV to V3.3-BUG_FIX 18011 : ETHREEOH-3804 - IMAP message body doesn't appears in IMAP folder when message subject is equal to the attachment name 20332 : Build fix - rework to the ImapServiceUnit tests. 20325 : build fix 20318 : MERGE DEV TO V3.3-BUG-FIX 20287 : ALF-2754: Alfresco IMAP and Zimbra Desktop Client. 20317 : ALF-2716 - imap mail metadata extraction fails when alfresco server locale is non English This change reworks the received date metadata extraction. 20316 : ALF-1912 : Problem with IMAP Sites visibility Now only IMAP favouries are shown. Also major rework to the way that this service uses the FileFolderService. 20315 : ALF-1912 Updates to the FileFolderService to support the Imap Service - add listDeepFolders - remove "makeFolders" which moves to its own Utility class. - update to JavaDoc 20429: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: 20171: 3.3SP1 bug fix branch 20174: Fix for ALF-960 and ALFCOM-1980: WCM - File Picker Restriction relative to folder not web project 20179: ALF-2629 Now when a workflow timer signals a transition it also ends the associated task. 20433: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: 20184: ALF-2772: Added new test case to RepoTransferReceiverImplTest and fixed the fault in the primary manifest processor. 20196: Temporary fix to SandboxServiceImplTest, which reverses the fix to ALF-2529. 20434: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: (RECORD ONLY) 20213: (RECORD ONLY) Merge from V3.3 to V3.3-BUG-FIX r20176 Merge from V3.2 to V3.3. r20175. JMX configuration of enterprise logging broken (fix). 20215: (RECORD ONLY) Merge from V3.3 to V3.3-BUG-FIX r20178 JodConverter loggers are now exposed in JMX. 20218: (RECORD ONLY) Merged BRANCHES/V3.3 to BRANCHES/DEV/V3.3-BUG-FIX: 20195: Form fields for numbers are now rendered much smaller that ... 20248: (RECORD ONLY) Merging HEAD into V3.3 20284: (RECORD ONLY) Merged BRANCHES/V3.3 to BRANCHES/DEV/V3.3-BUG-FIX: 20177: Add 'MaxPermSize' setting for DOD JUnit tests 20305: (RECORD ONLY) Merged BRANCHES/V3.3 to BRANCHES/DEV/V3.3-BUG-FIX: 20236: Add Oracle support for creating/dropping "databases" (users) in continuous.xml 20264: Updated Oracle build support (to fix grants) 20435: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: 20233: Part fix for ALF-2811: DOD5015 module breaks CMIS tck 20239: Final part of fix for ALF-2811: DOD5015 module breaks CMIS tck 20250: Merge from DEV/BELARUS/HEAD-2010_04_28 to V3.3-BUG-FIX 20230 ALF-2450: latin/utf-8 HTML file cannot be text-extracted. 20253: ALF-2629 Now tasks should correctly be ended when an associated timer is triggered. Should no longer cause WCM workflows to fail. 20254: ALF-2579 Changed teh status code on incorrect password to '401' to reflect that it is an authorisation error. 20263: Fix for ALF-2500: query with a ! in contains search make it strange 20265: Fix for ALF-1495. Reindexing of OOo-transformed content after OOo crash. 20436: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: 20292: (RECORD ONLY) Latest SpringSurf libs: 20308: (RECORD ONLY) Latest SpringSurf libs: 20366: (RECORD ONLY) Latest SpringSurf libs: 20415: Latest SpringSurf libs: 20437: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: 20270: Build times: SearchTestSuite 20273: Fix for ALF-2125 - Accessing a deleted page in Share does not return an error page, instead the document-details page breaks 20274: Fix for ALF-2518: It's impossible to find user by user name in Add User or Group window at Manage permissions page (also allows users to be found by username in the Share Admin Console). 20277: Fix for ALF-2417: Create Web Content Wizard if cancelling/aborting Step Two - Author Web Content, any asset being uploaded gets locked 20291: Reduce build time: Added security test suite to cover 17 security tests 20439: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: 20302: Fixed ALF-727: Oracle iBatis fails on PropertyValueDAOTest Double.MAX_VALUE 20307: VersionStore - minor fixes if running deprecated V1 20310: Fixed a bug in UIContentSelector which was building lucene search queries incorrectly. 20314: Fix for ALF-2789 - DispatcherServlet not correctly retrieving Object ID from request parameters 20320: Merged DEV/TEMPORARY to V3.3-BUG-FIX 20313: ALF-2507: Not able to email space users even if the user owns the space 20324: Fixed ALF-2078 "Content doesn't make checked in after applying 'Check-in' rule in Share" 20327: Fix Quickr project to compile in Eclipse 20367: ALF-2829: Avoid reading entire result set into memory in FixNameCrcValuesPatch 20368: Work-around for ALF-2366: patch.updateDmPermissions takes too long to complete 20369: Part 1 of fix for ALF-2943: Update incorrect mimetypes (Excel and Powerpoint) 20370: Version Migrator (ALF-1000) - use common batch processor to enable multiple workers 20373: Version Migrator (ALF-1000) - resolve runtime conflict (w/ r20334) 20378: Merged BRANCHES/DEV/BELARUS/HEAD-2010_04_28 to BRANCHES/DEV/V3.3-BUG-FIX: 20312: ALF-2162: Error processing WCM form: XFormsBindingException: property 'constraint' already present at model item 20381: Fixed ALF-2943: Update incorrect mimetypes (Excel and Powerpoint) git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@20571 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
308 lines
14 KiB
Java
308 lines
14 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.alfresco.service.cmr.model;
|
|
|
|
import java.util.List;
|
|
|
|
import org.alfresco.service.Auditable;
|
|
import org.alfresco.service.PublicService;
|
|
import org.alfresco.service.cmr.repository.ContentReader;
|
|
import org.alfresco.service.cmr.repository.ContentWriter;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.namespace.QName;
|
|
|
|
/**
|
|
* Provides methods specific to manipulating {@link org.alfresco.model.ContentModel#TYPE_CONTENT files}
|
|
* and {@link org.alfresco.model.ContentModel#TYPE_FOLDER folders}.
|
|
*
|
|
* So this interface provides a simple way of accessing simple trees of files and folders in Alfresco.
|
|
*
|
|
* @see org.alfresco.model.ContentModel
|
|
*
|
|
* @author Derek Hulley
|
|
*/
|
|
@PublicService
|
|
public interface FileFolderService
|
|
{
|
|
/**
|
|
* Lists immediate child files and folders of the given context node
|
|
*
|
|
* @param contextNodeRef the node to start searching in
|
|
* @return Returns a list of matching files and folders
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef"})
|
|
public List<FileInfo> list(NodeRef contextNodeRef);
|
|
|
|
/**
|
|
* Lists all immediate child files of the given context node
|
|
*
|
|
* @param folderNodeRef the folder to start searching in
|
|
* @return Returns a list of matching files
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"folderNodeRef"})
|
|
public List<FileInfo> listFiles(NodeRef folderNodeRef);
|
|
|
|
/**
|
|
* Lists all immediate child folders of the given context node
|
|
*
|
|
* @param contextNodeRef the node to start searching in
|
|
* @return Returns a list of matching folders
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef"})
|
|
public List<FileInfo> listFolders(NodeRef contextNodeRef);
|
|
|
|
/**
|
|
* Lists all folders below the given context node, both immediate and lower levels
|
|
*
|
|
* The filter parameter allows subfolders to be excluded from the search.
|
|
*
|
|
* @param contextNodeRef the node to start searching in
|
|
* @param filter - may be null in which case all sub-folders will be searched
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef"})
|
|
public List<FileInfo> listDeepFolders(NodeRef contextNodeRef, SubFolderFilter filter);
|
|
|
|
/**
|
|
* Get a node ref of the node that has the name within the parent node
|
|
*
|
|
* @param contextNodeRef the parent node
|
|
* @param name the name of the node to search for
|
|
* @return Returns the node that has the given name - or null if not found
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef", "name"})
|
|
public NodeRef searchSimple(NodeRef contextNodeRef, String name);
|
|
|
|
|
|
/**
|
|
* Searches for all files and folders with the matching name pattern,
|
|
* using wildcard characters <b>*</b> and <b>?</b>.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param contextNodeRef the context of the search. This node will never be returned
|
|
* as part of the search results.
|
|
* @param namePattern the name of the file or folder to search for, or a
|
|
* {@link org.alfresco.util.SearchLanguageConversion#DEF_LUCENE wildcard} pattern
|
|
* to search for.
|
|
* @param includeSubFolders true to search the entire hierarchy below the search context
|
|
* @return Returns a list of file or folder matches
|
|
*
|
|
* @see #search(NodeRef, String, boolean, boolean, boolean)
|
|
* @deprecated for shallow search use list, listFolders, listFiles, searchSimple.
|
|
* For deep listing use listDeepFolders.
|
|
* Avoid calling this method with any name pattern except for "*".
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef", "namePattern", "includeSubFolders"})
|
|
public List<FileInfo> search(
|
|
NodeRef contextNodeRef,
|
|
String namePattern,
|
|
boolean includeSubFolders);
|
|
|
|
/**
|
|
* Perform a search against the name of the files or folders within a hierarchy.
|
|
* Wildcard characters are <b>*</b> and <b>?</b>.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param contextNodeRef the context of the search. This node will never be returned
|
|
* as part of the search results.
|
|
* @param namePattern the name of the file or folder to search for, or a
|
|
* {@link org.alfresco.util.SearchLanguageConversion#DEF_LUCENE wildcard} pattern
|
|
* to search for.
|
|
* @param fileSearch true if file types are to be included in the search results
|
|
* @param folderSearch true if folder types are to be included in the search results
|
|
* @param includeSubFolders true to search the entire hierarchy below the search context
|
|
* @return Returns a list of file or folder matches
|
|
* @deprecated for shallow search use list, listFolders, listFiles, searchSimple.
|
|
* For deep listing use listDeepFolders.
|
|
* Avoid calling this method with any name pattern except for "*".
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef", "namePattern", "fileSearch", "folderSearch", "includeSubFolders"})
|
|
public List<FileInfo> search(
|
|
NodeRef contextNodeRef,
|
|
String namePattern,
|
|
boolean fileSearch,
|
|
boolean folderSearch,
|
|
boolean includeSubFolders);
|
|
|
|
/**
|
|
* Rename a file or folder in its current location
|
|
*
|
|
* @param fileFolderRef the file or folder to rename
|
|
* @param newName the new name
|
|
* @return Return the new file info
|
|
* @throws FileExistsException if a file or folder with the new name already exists
|
|
* @throws FileNotFoundException the file or folder reference doesn't exist
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"fileFolderRef", "newName"})
|
|
public FileInfo rename(NodeRef fileFolderRef, String newName) throws FileExistsException, FileNotFoundException;
|
|
|
|
/**
|
|
* Move a file or folder to a new name and/or location.
|
|
* <p>
|
|
* If both the parent folder and name remain the same, then nothing is done.
|
|
*
|
|
* @param sourceNodeRef the file or folder to move
|
|
* @param targetParentRef the new parent node to move the node to - null means rename in situ
|
|
* @param newName the name to change the file or folder to - null to keep the existing name
|
|
* @return Returns the new file info
|
|
* @throws FileExistsException
|
|
* @throws FileNotFoundException
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"sourceNodeRef", "targetParentRef", "newName"})
|
|
public FileInfo move(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName)
|
|
throws FileExistsException, FileNotFoundException;
|
|
|
|
/**
|
|
* Copy a source file or folder. The source can be optionally renamed and optionally
|
|
* moved into another folder.
|
|
* <p>
|
|
* If both the parent folder and name remain the same, then nothing is done.
|
|
*
|
|
* @param sourceNodeRef the file or folder to copy
|
|
* @param targetParentRef the new parent node to copy the node to - null means rename in situ
|
|
* @param newName the new name, or null to keep the existing name.
|
|
* @return Return the new file info
|
|
* @throws FileExistsException
|
|
* @throws FileNotFoundException
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"sourceNodeRef", "targetParentRef", "newName"})
|
|
public FileInfo copy(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName)
|
|
throws FileExistsException, FileNotFoundException;
|
|
|
|
/**
|
|
* Create a file or folder; or any valid node of type derived from file or folder.
|
|
* <p>
|
|
* The association QName for the patch defaults to <b>cm:filename</b> i.e. the
|
|
* <b>Content Model</b> namespace with the filename as the local name.
|
|
*
|
|
* @param parentNodeRef the parent node. The parent must be a valid
|
|
* {@link org.alfresco.model.ContentModel#TYPE_FOLDER folder}.
|
|
* @param name the name of the node
|
|
* @param typeQName the type to create
|
|
* @return Returns the new node's file information
|
|
* @throws FileExistsException
|
|
*
|
|
* @see {@link #create(NodeRef, String, QName, QName)}
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"parentNodeRef", "name", "typeQName"})
|
|
public FileInfo create(NodeRef parentNodeRef, String name, QName typeQName) throws FileExistsException;
|
|
|
|
/**
|
|
* Create a file or folder; or any valid node of type derived from file or folder
|
|
*
|
|
* @param parentNodeRef the parent node. The parent must be a valid
|
|
* {@link org.alfresco.model.ContentModel#TYPE_FOLDER folder}.
|
|
* @param name the name of the node
|
|
* @param typeQName the type to create
|
|
* @param assocQName the association QName to set for the path (may be <tt>null</tt>).
|
|
* @return Returns the new node's file information
|
|
* @throws FileExistsException
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"parentNodeRef", "name", "typeQName"})
|
|
public FileInfo create(NodeRef parentNodeRef, String name, QName typeQName, QName assocQName) throws FileExistsException;
|
|
|
|
/**
|
|
* Delete a file or folder
|
|
*
|
|
* @param nodeRef the node to delete
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
|
|
public void delete(NodeRef nodeRef);
|
|
|
|
/**
|
|
* Get the file or folder names from the root down to and including the node provided.
|
|
* <ul>
|
|
* <li>The root node can be of any type and is not included in the path list.</li>
|
|
* <li>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.</li>
|
|
* <li>If an invalid type is encountered along the path, then an exception is generated.</li>
|
|
* </ul>
|
|
*
|
|
* @param rootNodeRef the start of the returned path, or null if the <b>store</b> root
|
|
* node must be assumed.
|
|
* @param nodeRef a reference to the file or folder
|
|
* @return 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
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"rootNodeRef", "nodeRef"})
|
|
public List<FileInfo> getNamePath(NodeRef rootNodeRef, NodeRef nodeRef) throws FileNotFoundException;
|
|
|
|
/**
|
|
* Resolve a file or folder name path from a given root node down to the final node.
|
|
*
|
|
* @param rootNodeRef the start point node - a cm:folder type or subtype, e.g. the Company Home's nodeRef
|
|
* @param pathElements a list of names in the path. Do not include the referenced rootNodeRef's path element.
|
|
* @return Returns the info of the file or folder
|
|
* @throws FileNotFoundException if no file or folder exists along the path
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"rootNodeRef", "pathElements"})
|
|
public FileInfo resolveNamePath(NodeRef rootNodeRef, List<String> pathElements) throws FileNotFoundException;
|
|
|
|
/**
|
|
* Get the file info (name, folder, etc) for the given node
|
|
*
|
|
* @param nodeRef the node to get info for
|
|
* @return Returns the file info or null if the node does not represent a file or folder
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
|
|
public FileInfo getFileInfo(NodeRef nodeRef);
|
|
|
|
/**
|
|
* 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)
|
|
*
|
|
* @param nodeRef the content node
|
|
* @return Returns a handle to the content associated with the node
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
|
|
public ContentReader getReader(NodeRef nodeRef);
|
|
|
|
/**
|
|
* 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)
|
|
*
|
|
* @param nodeRef the content node
|
|
* @return Returns a handle to the content associated with the node
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
|
|
public ContentWriter getWriter(NodeRef nodeRef);
|
|
|
|
|
|
/**
|
|
* Check the validity of a node reference
|
|
*
|
|
* @return returns <tt>true</tt> if the NodeRef is valid
|
|
*/
|
|
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
|
|
public boolean exists(NodeRef nodeRef);
|
|
|
|
/**
|
|
* Checks the type for whether it is a recognised file or folder type or is invalid for the FileFolderService.
|
|
*
|
|
* @param typeQName the type to check
|
|
* @return - the type
|
|
*/
|
|
@Auditable(parameters = {"typeQName"})
|
|
public FileFolderServiceType getType(QName typeQName);
|
|
}
|