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    /**
024     * @version $Rev: 515007 $ $Date: 2007-03-06 18:26:41 +1100 (Tue, 06 Mar 2007) $
025     */
026    public class DistributeCommandMetaData extends BaseCommandMetaData  {
027        public static final CommandMetaData META_DATA = new DistributeCommandMetaData();
028        
029        private DistributeCommandMetaData() {
030            super("distribute", "2. Other Commands", "[--inPlace] [--targets target;target;...] [module] [plan]",
031                    "Processes a module and adds it to the server environment, but does "+
032                    "not start it or mark it to be started in the future. " +
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 no targets are provided, the module is distributed to all available " +
039                    "targets.  Geronimo only provides one target (ever), so this is primarily " +
040                    "useful when using a different driver.\n" +
041                    "If inPlace is provided, the module is not copied to the configuration " +
042                    "store of the selected targets. The targets directly use the module.");
043        }
044    
045        public CommandArgs parse(String[] args) throws CLParserException {
046            return new DistributeCommandArgs(args);
047        }
048        
049    }