org.apache.karaf.features.command.InstallFeatureCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.karaf.features.command Show documentation

This bundle provides the Karaf shell commands to manipulate features.

There is a newer version: 4.4.6

Show newest version

/*
 * 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.karaf.features.command;

import java.util.EnumSet;
import java.util.List;

import org.apache.karaf.shell.commands.Option;
import org.apache.karaf.features.FeaturesService;
import org.apache.karaf.shell.commands.Argument;
import org.apache.karaf.shell.commands.Command;

@Command(scope = "feature", name = "install", description = "Installs a feature with the specified name and version.")
public class InstallFeatureCommand extends FeaturesCommandSupport {

    private static String DEFAULT_VERSION = "0.0.0";

    @Argument(index = 0, name = "features", description = "The name and version of the features to install. A feature id looks like name/version. The version is optional.", required = true, multiValued = true)
    List features;
    @Option(name = "-c", aliases = "--no-clean", description = "Do not uninstall bundles on failure", required = false, multiValued = false)
    boolean noClean;
    @Option(name = "-r", aliases = "--no-auto-refresh", description = "Do not automatically refresh bundles", required = false, multiValued = false)
    boolean noRefresh;
    @Option(name = "-s", aliases = "--no-auto-start", description = "Do not automatically start bundles", required = false, multiValued = false)
    boolean noStart;
    @Option(name = "-v", aliases = "--verbose", description = "Explain what is being done", required = false, multiValued = false)
    boolean verbose;

    protected void doExecute(FeaturesService admin) throws Exception {
        for (String feature : features) {
            String[] split = feature.split("/");
            String name = split[0];
            String version = null;
            if (split.length == 2) {
                version = split[1];
            }
    	    if (version == null || version.length() == 0) {
                version = DEFAULT_VERSION;
    	    }
            EnumSet options = EnumSet.of(FeaturesService.Option.PrintBundlesToRefresh);
            if (noRefresh) {
                options.add(FeaturesService.Option.NoAutoRefreshBundles);
            }
            if (noClean) {
                options.add(FeaturesService.Option.NoCleanIfFailure);
            }
            if (noStart) {
                options.add(FeaturesService.Option.NoAutoStartBundles);
            }
            if (verbose) {
                options.add(FeaturesService.Option.Verbose);
            }
            admin.installFeature(name, version, options);
        }
    }
}