src/site/apt/usage.apt.vm

 ------
 Usage
 ------
 Stephane Nicoll
 <snicoll@apache.org>
 Pete Marvin King
 ------
 2012-02-01
 ------

 ~~ 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.

 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/doxia/references/apt-format.html


Usage

  The EJB Plugin is used to package an EJB module. There are two ways to use the EJB Plugin:

  * If the packaging type defined in the <<<pom.xml>>> is <<<ejb>>>, the <<<package>>> lifecycle phase can be used

+--------------+
  mvn package
+--------------+

  * or using the <<<ejb:ejb>>> goal

+--------------+
  mvn ejb:ejb
+--------------+

 []

  To handle archiving this version of Maven EJB Plugin uses
  {{{/shared/maven-archiver/index.html}Maven Archiver}} ${mavenArchiverVersion}.

  To handle filtering this version of Maven EJB Plugin uses
  {{{/shared/maven-filtering/index.html}Maven Filtering}} ${mavenFilteringVersion}.

  The plugin doesn't do any EJB specific processing during the generation of the JAR except for validating the existence
  of an EJB deployment descriptor if the EJB version is 2.0+, but it provides the following customization:

  * The EJB version to use

  * {{{./examples/generating-ejb-client.html}Generating and customizing an ejb-client}}

  <<Note:>> The dependencies will not be package with the EJB JAR.

* Specifying the EJB version to use

  The plugin generates according to the EJB version specified by the {{{./ejb-mojo.html#ejbVersion}ejbVersion}}
  parameter. To use some other version than the default, configure the plugin as in the example below:

+--------
  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-ejb-plugin</artifactId>
          <version>${project.version}</version>
          <configuration>
            <ejbVersion>3.0</ejbVersion>
          </configuration>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
+---------