mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
3a5a22da8d
126348 jkaabimofrad: Merged FILE-FOLDER-API (5.2.0) to HEAD (5.2)
118663 jvonka: Merge from DEV/SABRE_JANV1 (part 1)
File Folder API (PoC - experimental WIP)
- relates to RA-613
- initial file folder CRUD including
- * list folder children (minimal info by default)
with sorting, paging & optional isFolder=true/false
- * create folders or (empty) files
- * get node info
with id, name, nodeType, auditable props, properties (not sys:referencable), aspectNames, ...
- * put node info
- * put content (upload file)
- * get content (download file)
- * delete node (cascade for folder)
- * support for well-known folder alias, -root-, -my-, -shared-
- TODO add tests
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@126693 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
116 lines
3.9 KiB
Java
116 lines
3.9 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Remote API
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* 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/>.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.rest.api;
|
|
|
|
import java.util.Set;
|
|
|
|
import org.alfresco.rest.api.model.Document;
|
|
import org.alfresco.rest.api.model.Folder;
|
|
import org.alfresco.rest.api.model.Node;
|
|
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
|
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.repository.StoreRef;
|
|
import org.alfresco.service.namespace.QName;
|
|
|
|
/**
|
|
* @author steveglover
|
|
* @author janv
|
|
*/
|
|
public interface Nodes
|
|
{
|
|
NodeRef validateNode(StoreRef storeRef, String nodeId);
|
|
NodeRef validateNode(String nodeId);
|
|
NodeRef validateNode(NodeRef nodeRef);
|
|
boolean nodeMatches(NodeRef nodeRef, Set<QName> expectedTypes, Set<QName> excludedTypes);
|
|
|
|
/**
|
|
* Get the node representation for the given node.
|
|
* @param nodeId String
|
|
* @return Node
|
|
*/
|
|
Node getNode(String nodeId);
|
|
|
|
/**
|
|
* Get the document representation for the given node.
|
|
* @param nodeRef NodeRef
|
|
* @return Document
|
|
*/
|
|
Document getDocument(NodeRef nodeRef);
|
|
|
|
/**
|
|
* Get the folder representation for the given node.
|
|
* @param nodeRef NodeRef
|
|
* @return Folder
|
|
*/
|
|
Folder getFolder(NodeRef nodeRef);
|
|
|
|
/**
|
|
* Get the folder or document representation (as appropriate) for the given node.
|
|
* @param nodeId String nodeId or well-known alias, eg. "-root-" or "-my-"
|
|
* @param parameters the {@link Parameters} object to get the parameters passed into the request
|
|
* including:
|
|
* - incPrimaryParent
|
|
* @return
|
|
*/
|
|
Node getFolderOrDocument(String nodeId, Parameters parameters);
|
|
|
|
/**
|
|
* Get list of children of a parent folder.
|
|
* @param parentFolderNodeId String id of parent folder node or well-known alias, eg. "-root-" or "-my-"
|
|
* @param parameters the {@link Parameters} object to get the parameters passed into the request
|
|
* including:
|
|
* - filter, sort & paging params (where, orderBy, skipCount, maxItems)
|
|
* - incFiles, incFolders (both true by default)
|
|
* @return a paged list of {@code org.alfresco.rest.api.model.Node} objects
|
|
*/
|
|
CollectionWithPagingInfo<Node> getChildren(String parentFolderNodeId, Parameters parameters);
|
|
|
|
/**
|
|
* Delete the given node. Note: will cascade delete for a folder.
|
|
* @param nodeId String id of node (folder or document)
|
|
*/
|
|
void deleteNode(String nodeId);
|
|
|
|
/**
|
|
*
|
|
* @param parentFolderNodeId
|
|
* @param folderInfo
|
|
* @param parameters
|
|
* @return
|
|
*/
|
|
Folder createFolder(String parentFolderNodeId, Folder folderInfo, Parameters parameters);
|
|
|
|
/**
|
|
*
|
|
* @param nodeId
|
|
* @param entity
|
|
* @param parameters
|
|
* @return
|
|
*/
|
|
Node updateNode(String nodeId, Node entity, Parameters parameters);
|
|
}
|