001/*
002 * (C) Copyright 2006-2010 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 *     bstefanescu
018 */
019package org.nuxeo.shell.automation.cmds;
020
021import org.nuxeo.ecm.automation.client.model.DocRef;
022import org.nuxeo.shell.Argument;
023import org.nuxeo.shell.Command;
024import org.nuxeo.shell.Context;
025import org.nuxeo.shell.ShellException;
026import org.nuxeo.shell.automation.DocRefCompletor;
027import org.nuxeo.shell.automation.RemoteContext;
028
029/**
030 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
031 */
032@Command(name = "unlock", help = "Unlock a document")
033public class Unlock implements Runnable {
034
035    @Context
036    protected RemoteContext ctx;
037
038    @Argument(name = "doc", index = 0, required = false, completor = DocRefCompletor.class, help = "The document to unlock. If not specified the current document is used. To use UID references prefix them with 'doc:'.")
039    protected String path;
040
041    public void run() {
042        DocRef doc = ctx.resolveRef(path);
043        try {
044            ctx.getDocumentService().unlock(doc);
045        } catch (Exception e) {
046            throw new ShellException("Failed to unlock " + doc, e);
047        }
048
049    }
050}