001/*
002 * (C) Copyright 2006-2010 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     bstefanescu
016 */
017package org.nuxeo.shell.automation.cmds;
018
019import org.nuxeo.ecm.automation.client.model.DocRef;
020import org.nuxeo.shell.Argument;
021import org.nuxeo.shell.Command;
022import org.nuxeo.shell.Context;
023import org.nuxeo.shell.Parameter;
024import org.nuxeo.shell.ShellException;
025import org.nuxeo.shell.automation.DocRefCompletor;
026import org.nuxeo.shell.automation.RemoteContext;
027
028/**
029 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
030 */
031@Command(name = "setp", help = "Set a property on a document")
032public class SetProperty implements Runnable {
033
034    @Context
035    protected RemoteContext ctx;
036
037    @Parameter(name = "-xpath", hasValue = true, help = "The xpath of the property to set. This parameter is required.")
038    protected String xpath;
039
040    @Parameter(name = "-value", hasValue = true, help = "The property value. If not specified the current property value is removed.")
041    protected String value;
042
043    @Argument(name = "doc", index = 0, required = false, completor = DocRefCompletor.class, help = "The target document. If not specified the current document is used. To use UID references prefix them with 'doc:'.")
044    protected String path;
045
046    public void run() {
047        DocRef doc = ctx.resolveRef(path);
048        if (xpath == null) {
049            throw new ShellException("-xpath parameter is required!");
050        }
051        try {
052            if (value != null) {
053                ctx.getDocumentService().setProperty(doc, xpath, value);
054            } else {
055                ctx.getDocumentService().removeProperty(doc, xpath);
056            }
057        } catch (Exception e) {
058            throw new ShellException("Failed to set property on " + doc, e);
059        }
060
061    }
062}