001    /**
002     *
003     * Copyright 2003-2004 The Apache Software Foundation
004     *
005     *  Licensed under the Apache License, Version 2.0 (the "License");
006     *  you may not use this file except in compliance with the License.
007     *  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    
018    package org.apache.geronimo.deployment.cli;
019    
020    import org.apache.geronimo.common.DeploymentException;
021    
022    import java.io.PrintWriter;
023    
024    /**
025     * An abstraction of various CLI deployer commands.  Holds metadata like help
026     * text, and also the logic to validate arguments and execute the command.
027     *
028     * @version $Rev: 355877 $ $Date: 2005-12-10 18:48:27 -0800 (Sat, 10 Dec 2005) $
029     */
030    public interface DeployCommand {
031        String getCommandGroup();
032        String getCommandName();
033        String getHelpArgumentList();
034        String getHelpText();
035        boolean isLocalOnly();
036        void execute(PrintWriter out, ServerConnection connection, String[] args) throws DeploymentException;
037    }