karaf-2.3.x/shell/scr/src/main/java/org/apache/karaf/shell/scr/action/DeactivateAction.java

/*
 * 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.shell.scr.action;

import org.apache.felix.gogo.commands.Argument;
import org.apache.felix.gogo.commands.Command;
import org.apache.felix.scr.Component;
import org.apache.felix.scr.ScrService;
import org.apache.karaf.shell.scr.ScrCommandConstants;

/**
 * Deactivates the given component by supplying its component name.
 */
@Command(scope = ScrCommandConstants.SCR_COMMAND, 
         name = ScrCommandConstants.DEACTIVATE_FUNCTION, 
         description = "Deactivates a Component for the given name")
public class DeactivateAction extends ScrActionSupport {

    @Argument(index = 0, 
              name = "name", 
              description = "The name of the Component to deactivate ", 
              required = true, 
              multiValued = false)
    String name;

    @Override
    protected Object doScrAction(ScrService scrService) throws Exception {
        if (logger.isDebugEnabled()) {
            logger.debug("Deactivate Action");
            logger.debug("  Deactivating the Component: " + name);
        }
        Component[] components = scrService.getComponents(name);
        if (components != null && components.length > 0) {
            for (int i = 0; i < components.length; i++) {
                components[i].disable();
            }
        }
        return null;
    }

}