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;
022
023import org.nuxeo.drive.adapter.FileSystemItem;
024import org.nuxeo.drive.service.FileSystemItemManager;
025import org.nuxeo.ecm.automation.InvalidOperationException;
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 * Renames the document backing the {@link FileSystemItem} with the given id to the given name.
038 *
039 * @author Antoine Taillefer
040 */
041@Operation(id = NuxeoDriveRename.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: Rename", description = "Rename the document backing the file system item with the given id to the given name." //
042        + " Return the file system item backed by the renamed document as a JSON blob.")
043public class NuxeoDriveRename {
044
045    public static final String ID = "NuxeoDrive.Rename";
046
047    @Context
048    protected OperationContext ctx;
049
050    @Param(name = "id", description = "Id of the file system item backed by the document to rename.")
051    protected String id; // NOSONAR
052
053    @Param(name = "name", description = "The new name.")
054    protected String name;
055
056    @OperationMethod
057    public Blob run() throws InvalidOperationException, IOException {
058        FileSystemItemManager fileSystemItemManager = Framework.getService(FileSystemItemManager.class);
059        FileSystemItem fsItem;
060        try {
061            fsItem = fileSystemItemManager.rename(id, name, ctx.getPrincipal());
062        } catch (UnsupportedOperationException e) {
063            throw new InvalidOperationException(e);
064        }
065
066        return Blobs.createJSONBlobFromValue(fsItem);
067    }
068
069}