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.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.runtime.api.Framework;
034
035/**
036 * Renames the {@link FileSystemItem} with the given id with the given name for the currently authenticated user.
037 *
038 * @author Antoine Taillefer
039 */
040@Operation(id = NuxeoDriveRename.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: Rename")
041public class NuxeoDriveRename {
042
043    public static final String ID = "NuxeoDrive.Rename";
044
045    @Context
046    protected OperationContext ctx;
047
048    @Param(name = "id")
049    protected String id;
050
051    @Param(name = "name")
052    protected String name;
053
054    @OperationMethod
055    public Blob run() throws InvalidOperationException, IOException {
056
057        FileSystemItemManager fileSystemItemManager = Framework.getLocalService(FileSystemItemManager.class);
058        FileSystemItem fsItem;
059        try {
060            fsItem = fileSystemItemManager.rename(id, name, ctx.getPrincipal());
061        } catch (UnsupportedOperationException e) {
062            throw new InvalidOperationException(e);
063        }
064
065        return NuxeoDriveOperationHelper.asJSONBlob(fsItem);
066    }
067
068}