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.Parameter;
026import org.nuxeo.shell.ShellException;
027import org.nuxeo.shell.automation.DocRefCompletor;
028import org.nuxeo.shell.automation.RemoteContext;
029
030/**
031 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
032 */
033@Command(name = "getp", help = "Get the value of a document property")
034public class GetProperty implements Runnable {
035
036    @Context
037    protected RemoteContext ctx;
038
039    @Parameter(name = "-xpath", hasValue = true, help = "The xpath of the property to get. This parameter is required.")
040    protected String xpath;
041
042    @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:'.")
043    protected String path;
044
045    public void run() {
046        DocRef doc = ctx.resolveRef(path);
047        if (xpath == null) {
048            throw new ShellException("-xpath parameter is required!");
049        }
050        try {
051            Object p = ctx.getDocumentService().getDocument(doc, "*").getProperties().get(xpath);
052            if (p != null) {
053                ctx.getShell().getConsole().println(p.toString());
054            }
055        } catch (Exception e) {
056            throw new ShellException("Failed to get property on " + doc, e);
057        }
058
059    }
060}