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 * Checks if the document backing the {@link FileSystemItem} with the given id exists.
037 *
038 * @author Antoine Taillefer
039 */
040@Operation(id = NuxeoDriveFileSystemItemExists.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: File system item exists", description = "Check if the document backing the file system item with the given id exists." //
041        + " Return the result as a JSON blob.")
042public class NuxeoDriveFileSystemItemExists {
043
044    public static final String ID = "NuxeoDrive.FileSystemItemExists";
045
046    @Context
047    protected OperationContext ctx;
048
049    @Param(name = "id", description = "Id of the file system item backed by the document whose existence to check.")
050    protected String id; // NOSONAR
051
052    @OperationMethod
053    public Blob run() throws IOException {
054        FileSystemItemManager fileSystemItemManager = Framework.getService(FileSystemItemManager.class);
055        boolean exists = fileSystemItemManager.exists(id, ctx.getPrincipal());
056        return Blobs.createJSONBlobFromValue(exists);
057    }
058
059}