mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
17012b17b6
118692 jvonka: Merge from DEV/SABRE_JANV1 (part 2) - RA-613 / RA-655 - File Folder API (PoC - experimental WIP) - TODO add tests +review backwards compat' (eg. favs) git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@126349 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
108 lines
3.8 KiB
Java
108 lines
3.8 KiB
Java
/*
|
|
* Copyright (C) 2005-2015 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.rest.api.nodes;
|
|
|
|
import org.alfresco.rest.api.Nodes;
|
|
import org.alfresco.rest.api.model.Folder;
|
|
import org.alfresco.rest.api.model.Node;
|
|
import org.alfresco.rest.framework.WebApiDescription;
|
|
import org.alfresco.rest.framework.resource.RelationshipResource;
|
|
import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction;
|
|
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
|
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
|
import org.alfresco.util.ParameterCheck;
|
|
import org.springframework.beans.factory.InitializingBean;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
|
|
/**
|
|
* TODO ... work-in-progress
|
|
*
|
|
* @author janv
|
|
*/
|
|
@RelationshipResource(name = "children", entityResource = NodesEntityResource.class, title = "Folder children")
|
|
public class NodeChildrenRelation implements RelationshipResourceAction.Read<Node>, RelationshipResourceAction.Create<Node>, InitializingBean
|
|
{
|
|
private Nodes nodes;
|
|
|
|
public void setNodes(Nodes nodes)
|
|
{
|
|
this.nodes = nodes;
|
|
}
|
|
|
|
@Override
|
|
public void afterPropertiesSet()
|
|
{
|
|
ParameterCheck.mandatory("nodes", this.nodes);
|
|
}
|
|
|
|
/**
|
|
* List folder children - returns a filtered/sorted/paged list of nodes that are immediate children of the parent folder
|
|
*
|
|
* TODO filtering, sorting, ...
|
|
* TODO metadata/properties & permissions etc ...
|
|
*
|
|
* @param parentFolderNodeId String id of parent folder - will also accept aliases "-root-" (Company Home) or "-my-" (current user's home folder)
|
|
*
|
|
* Optional query parameters:
|
|
*
|
|
* - incFiles
|
|
* - incFolders
|
|
*
|
|
* - properties
|
|
* - where
|
|
* - orderBy
|
|
*
|
|
* - skipCount
|
|
* - maxItems
|
|
*
|
|
* If parentFolderNodeId does not exist, EntityNotFoundException (status 404).
|
|
* If parentFolderNodeId does not represent a folder, InvalidArgumentException (status 400).
|
|
*/
|
|
@Override
|
|
@WebApiDescription(title = "Return a paged list of nodes for the document/folder identified by parentFolderNodeId")
|
|
public CollectionWithPagingInfo<Node> readAll(String parentFolderNodeId, Parameters parameters)
|
|
{
|
|
return nodes.getChildren(parentFolderNodeId, parameters);
|
|
}
|
|
|
|
/**
|
|
* Create one or more nodes (folder or empty file) below parent folder.
|
|
*
|
|
* Note: for parent folder nodeId, can also use well-known alias, eg. -root- or -my-
|
|
*
|
|
* If parentFolderNodeId does not exist, EntityNotFoundException (status 404).
|
|
* If parentFolderNodeId does not represent a folder, InvalidArgumentException (status 400).
|
|
*/
|
|
@Override
|
|
@WebApiDescription(title="Create one (or more) nodes as children of folder identified by parentFolderNodeId")
|
|
public List<Node> create(String parentFolderNodeId, List<Node> nodeInfos, Parameters parameters)
|
|
{
|
|
List<Node> result = new ArrayList<>(nodeInfos.size());
|
|
|
|
for (Node nodeInfo : nodeInfos)
|
|
{
|
|
result.add(nodes.createNode(parentFolderNodeId, nodeInfo, parameters));
|
|
}
|
|
|
|
return result;
|
|
}
|
|
}
|