org.apache.jackrabbit.vault.cli.extended.XDavEx 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.extended;

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.GroupBuilder;
import org.apache.jackrabbit.vault.util.console.ExecutionContext;

/**
 * {@code XJcrLog}...
 */
public class XDavEx extends ExtendedOption {

    public boolean execute(ExecutionContext executionContext, CommandLine commandLine)
            throws Exception {
        return false;
    }

    public String getSystemPrefix() {
        return "jcr.remoting.";
    }

    public String getName() {
        return "Xdavex";
    }

    public String getShortDescription() {
        return "Extended JCR remoting options (omit argument for help)";
    }

    public String getLongDescription() {
        return  "Configures extended options for the JCR remoting protocol.";
    }

    public String getExample() {
        return "Set depth to 2 and specify a log: -Xdavex:depth=2,spilog=my.log\n" +
               "     Set an empty referer header: -Xdavex:referer=,depth=2\n" +
               "   Set a specific referer header: -Xdavex:referer=http://my.server.com";
    }

    public boolean hasName(String s) {
        return false;
    }

    public Option getCommand() {
        return new CommandBuilder()
                .withName("Xdavex")
                .withDescription(getShortDescription())
                .withChildren(new GroupBuilder()
                        .withName("Options:")
                        .withOption(new ArgumentBuilder()
                                .withName("itemcache=")
                                .withDescription("size of the item cache in 1024. default 128")
                                .withMinimum(1)
                                .withMaximum(1)
                                .create())
                        .withOption(new ArgumentBuilder()
                                .withName("spilog=")
                                .withDescription("enable spi log and write to file")
                                .withMinimum(1)
                                .withMaximum(1)
                                .create())
                        .withOption(new ArgumentBuilder()
                                .withName("depth=")
                                .withDescription("retrieval depth. default 4")
                                .withMinimum(1)
                                .withMaximum(1)
                                .create())
                        .withOption(new ArgumentBuilder()
                                .withName("referer=")
                                .withDescription("HTTP Referer header to use for the requests. default is http://localhost/")
                                .withMinimum(1)
                                .withMaximum(1)
                                .create())
                        .create()
                )
                .create();
    }
}