001/*
002 * (C) Copyright 2012 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Antoine Taillefer <[email protected]>
018 */
019package org.nuxeo.drive.operations;
020
021import java.io.IOException;
022import java.util.List;
023
024import org.nuxeo.drive.adapter.FileSystemItem;
025import org.nuxeo.drive.adapter.FolderItem;
026import org.nuxeo.drive.service.FileSystemItemManager;
027import org.nuxeo.ecm.automation.OperationContext;
028import org.nuxeo.ecm.automation.core.Constants;
029import org.nuxeo.ecm.automation.core.annotations.Context;
030import org.nuxeo.ecm.automation.core.annotations.Operation;
031import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
032import org.nuxeo.ecm.automation.core.annotations.Param;
033import org.nuxeo.ecm.core.api.Blob;
034import org.nuxeo.ecm.core.api.Blobs;
035import org.nuxeo.runtime.api.Framework;
036
037/**
038 * Gets the children of the document backing the {@link FolderItem} with the given id.
039 *
040 * @author Antoine Taillefer
041 */
042@Operation(id = NuxeoDriveGetChildren.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: Get children", description = "Get the children of the document backing the folder item with the given id." //
043        + " Return the results as a JSON blob.")
044public class NuxeoDriveGetChildren {
045
046    public static final String ID = "NuxeoDrive.GetChildren";
047
048    @Context
049    protected OperationContext ctx;
050
051    @Param(name = "id", description = "Id of the file system item backed by the document whose children to get.")
052    protected String id; // NOSONAR
053
054    @OperationMethod
055    public Blob run() throws IOException {
056        FileSystemItemManager fileSystemItemManager = Framework.getService(FileSystemItemManager.class);
057        List<FileSystemItem> children = fileSystemItemManager.getChildren(id, ctx.getPrincipal());
058        return Blobs.createJSONBlobFromValue(children);
059    }
060
061}