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 RedeployCommandMetaData extends BaseCommandMetaData  {
026        public static final CommandMetaData META_DATA = new RedeployCommandMetaData();
027    
028        private RedeployCommandMetaData() {
029            super("redeploy", "1. Common Commands", "[module] [plan] [ModuleID|TargetModuleID+]",
030                    "A shortcut to undeploy a module from one or more servers, then " +
031                    "deploy a new version.  This is not a smooth cutover -- some client " +
032                    "requests may be rejected while the redeploy takes place.\n" +
033                    "Normally both a module and plan are passed to the deployer. " +
034                    "Sometimes the module contains a plan, or requires no plan, in which case " +
035                    "the plan may be omitted.  Sometimes the plan references a module already " +
036                    "deployed in the Geronimo server environment, in which case a module does " +
037                    "not need to be provided.\n" +
038                    "If more than one TargetModuleID is provided, all TargetModuleIDs " +
039                    "must refer to the same module (just running on different targets).\n" +
040                    "Regardless of whether the old module was running or not, the new " +
041                    "module will be started.\n" +
042                    "If no ModuleID or TargetModuleID is specified, and you're deploying to "+
043                    "Geronimo, the deployer will attempt to guess the correct ModuleID for "+
044                    "you based on the module and/or plan you provided.\n"+
045                    "Note: To specify a TargetModuleID, use the form TargetName|ModuleName");
046        }
047        
048        public CommandArgs parse(String[] newArgs) throws CLParserException {
049            if (newArgs.length == 0) {
050                throw new CLParserException("Must specify a module or plan (or both) and optionally module IDs to replace");
051            }
052            return super.parse(newArgs);
053        }
054    
055    }