001    /**
002     *  Licensed to the Apache Software Foundation (ASF) under one or more
003     *  contributor license agreements.  See the NOTICE file distributed with
004     *  this work for additional information regarding copyright ownership.
005     *  The ASF licenses this file to You under the Apache License, Version 2.0
006     *  (the "License"); you may not use this file except in compliance with
007     *  the License.  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    package org.apache.geronimo.cli.deployer;
018    
019    import org.apache.geronimo.cli.CLParserException;
020    
021    
022    /**
023     * @version $Rev: 515007 $ $Date: 2007-03-06 18:26:41 +1100 (Tue, 06 Mar 2007) $
024     */
025    public class UndeployCommandMetaData extends BaseCommandMetaData  {
026        public static final CommandMetaData META_DATA = new UndeployCommandMetaData();
027    
028        private UndeployCommandMetaData() {
029            super("undeploy", "1. Common Commands", "[ModuleID|TargetModuleID]+",
030                    "Accepts the configId of a module, or the fully-qualified " +
031                    "TargetModuleID identifying both the module and the server or cluster it's " +
032                    "on, stops that module, and removes the deployment files for that module " +
033                    "from the server environment.  If multiple modules are specified, they will " +
034                    "all be undeployed.");
035        }
036    
037        public CommandArgs parse(String[] newArgs) throws CLParserException {
038            if (newArgs.length == 0) {
039                throw new CLParserException("Must specify a module or target module to undeploy");
040            }
041            return super.parse(newArgs);
042        }
043    
044    }