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 <ataillefer@nuxeo.com>
018 */
019package org.nuxeo.drive.operations;
020
021import java.io.IOException;
022
023import org.nuxeo.drive.adapter.FileSystemItem;
024import org.nuxeo.drive.service.FileSystemItemManager;
025import org.nuxeo.ecm.automation.OperationContext;
026import org.nuxeo.ecm.automation.core.Constants;
027import org.nuxeo.ecm.automation.core.annotations.Context;
028import org.nuxeo.ecm.automation.core.annotations.Operation;
029import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
030import org.nuxeo.ecm.automation.core.annotations.Param;
031import org.nuxeo.ecm.core.api.Blob;
032import org.nuxeo.ecm.core.api.Blobs;
033import org.nuxeo.runtime.api.Framework;
034
035/**
036 * Get the {@link FileSystemItem} with the given id for the currently authenticated user.
037 *
038 * @author Antoine Taillefer
039 */
040@Operation(id = NuxeoDriveGetFileSystemItem.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: Get file system item")
041public class NuxeoDriveGetFileSystemItem {
042
043    public static final String ID = "NuxeoDrive.GetFileSystemItem";
044
045    @Context
046    protected OperationContext ctx;
047
048    @Param(name = "id")
049    protected String id;
050
051    /**
052     * @since 6.0
053     */
054    @Param(name = "parentId", required = false)
055    protected String parentId;
056
057    @OperationMethod
058    public Blob run() throws IOException {
059
060        FileSystemItemManager fileSystemItemManager = Framework.getLocalService(FileSystemItemManager.class);
061        FileSystemItem fsItem;
062        if (parentId == null) {
063            fsItem = fileSystemItemManager.getFileSystemItemById(id, ctx.getPrincipal());
064        } else {
065            fsItem = fileSystemItemManager.getFileSystemItemById(id, parentId, ctx.getPrincipal());
066        }
067        return Blobs.createJSONBlobFromValueJackson1(fsItem);
068    }
069
070}