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.adapter.FolderItem;
025import org.nuxeo.drive.service.FileSystemItemManager;
026import org.nuxeo.ecm.automation.OperationContext;
027import org.nuxeo.ecm.automation.core.Constants;
028import org.nuxeo.ecm.automation.core.annotations.Context;
029import org.nuxeo.ecm.automation.core.annotations.Operation;
030import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
031import org.nuxeo.ecm.automation.core.annotations.Param;
032import org.nuxeo.ecm.core.api.Blob;
033import org.nuxeo.ecm.core.api.Blobs;
034import org.nuxeo.runtime.api.Framework;
035
036/**
037 * Creates a folder with the given name in the {@link FileSystemItem} with the given id for the currently authenticated
038 * user.
039 *
040 * @author Antoine Taillefer
041 */
042@Operation(id = NuxeoDriveCreateFolder.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: Create folder")
043public class NuxeoDriveCreateFolder {
044
045    public static final String ID = "NuxeoDrive.CreateFolder";
046
047    @Context
048    protected OperationContext ctx;
049
050    @Param(name = "parentId")
051    protected String parentId;
052
053    @Param(name = "name")
054    protected String name;
055
056    /**
057     * @since 9.1
058     */
059    @Param(name = "overwrite", required = false)
060    protected boolean overwrite;
061
062    @OperationMethod
063    public Blob run() throws IOException {
064
065        FileSystemItemManager fileSystemItemManager = Framework.getService(FileSystemItemManager.class);
066        FolderItem folderItem = fileSystemItemManager.createFolder(parentId, name, ctx.getPrincipal(), overwrite);
067
068        return Blobs.createJSONBlobFromValueJackson1(folderItem);
069    }
070
071}