org.apache.jackrabbit.vault.cli.CmdStatus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vault-cli Show documentation
Provides a simple shell-like console that access the file vault.
There is a newer version: 3.8.2
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.jackrabbit.vault.cli;

import java.io.File;
import java.util.List;

import org.apache.commons.cli2.Argument;
import org.apache.commons.cli2.CommandLine;
import org.apache.commons.cli2.Option;
import org.apache.commons.cli2.builder.ArgumentBuilder;
import org.apache.commons.cli2.builder.CommandBuilder;
import org.apache.commons.cli2.builder.DefaultOptionBuilder;
import org.apache.commons.cli2.builder.GroupBuilder;
import org.apache.commons.cli2.option.Command;
import org.apache.jackrabbit.vault.vlt.VltContext;
import org.apache.jackrabbit.vault.vlt.actions.Action;
import org.apache.jackrabbit.vault.vlt.actions.RemoteStatus;
import org.apache.jackrabbit.vault.vlt.actions.Status;

/**
 * Implements the 'status' command.
 *
 */
public class CmdStatus extends AbstractVaultCommand {

    private Option optOnlyControlled;
    private Option optShowUpdate;
    private Option optNonRecursive;
    private Argument argLocalPath;

    @SuppressWarnings("unchecked")
    protected void doExecute(VaultFsApp app, CommandLine cl) throws Exception {
        List localPaths = cl.getValues(argLocalPath);
        List localFiles = app.getPlatformFiles(localPaths, false);
        File localDir = app.getPlatformFile("", true);

        VltContext vCtx = app.createVaultContext(localDir);
        vCtx.setVerbose(cl.hasOption(OPT_VERBOSE));
        vCtx.setQuiet(cl.hasOption(optOnlyControlled));
        Action a = cl.hasOption(optShowUpdate)
                ? new RemoteStatus(localDir, localFiles, cl.hasOption(optNonRecursive))
                : new Status(localDir, localFiles, cl.hasOption(optNonRecursive));
        vCtx.execute(a);
    }

    /**
     * {@inheritDoc}
     */
    public String getShortDescription() {
        return "Print the status of working copy files and directories.";
    }


    /**
     * {@inheritDoc}
     */
    public String getLongDescription() {
        return "Print the status of working copy files and directories.\n" +
                "\n" +
                "If --show-update is specified, each file is checked against " +
                "the remote version. the second letter then specifies what " +
                "action would be performed by an update operation.";
    }


    protected Command createCommand() {
        return new CommandBuilder()
                .withName("status")
                .withName("st")
                .withDescription(getShortDescription())
                .withChildren(new GroupBuilder()
                        .withName("Options:")
                        .withOption(OPT_VERBOSE)
                        .withOption(optOnlyControlled = new DefaultOptionBuilder()
                                .withShortName("q")
                                .withLongName("quiet")
                                .withDescription("show only status of controlled files")
                                .create())
                        .withOption(optShowUpdate = new DefaultOptionBuilder()
                                .withShortName("u")
                                .withLongName("show-update")
                                .withDescription("display update information")
                                .create())
                        .withOption(optNonRecursive = new DefaultOptionBuilder()
                                .withShortName("N")
                                .withLongName("non-recursive")
                                .withDescription("operate on single directory")
                                .create())
                        .withOption(argLocalPath = new ArgumentBuilder()
                                .withName("file")
                                .withDescription("file or directory to display the status")
                                .withMinimum(0)
                                .create()
                        )
                        .create()
                )
                .create();
    }
}