View Javadoc

1   package org.apache.tomcat.maven.plugin.tomcat6;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.plugin.MojoExecutionException;
23  
24  import java.io.File;
25  
26  /**
27   * Deploy a WAR in-place to Tomcat.
28   *
29   * @author Mark Hobson <markhobson@gmail.com>
30   * @version $Id: InplaceMojo.html 1305321 2012-03-26 12:01:12Z olamy $
31   * @goal inplace
32   * @todo depend on war:inplace when MNG-1649 resolved
33   */
34  public class InplaceMojo
35      extends AbstractDeployMojo
36  {
37      // ----------------------------------------------------------------------
38      // Mojo Parameters
39      // ----------------------------------------------------------------------
40  
41      /**
42       * The path of the inplace WAR directory to deploy.
43       *
44       * @parameter expression = "${basedir}/src/main/webapp"
45       * @required
46       */
47      private File warSourceDirectory;
48  
49      // ----------------------------------------------------------------------
50      // Protected Methods
51      // ----------------------------------------------------------------------
52  
53      /**
54       * {@inheritDoc}
55       */
56      @Override
57      protected File getWarFile()
58      {
59          return warSourceDirectory;
60      }
61  
62      /**
63       * {@inheritDoc}
64       */
65      @Override
66      protected void validateWarFile()
67          throws MojoExecutionException
68      {
69          if ( !warSourceDirectory.exists() || !warSourceDirectory.isDirectory() )
70          {
71              throw new MojoExecutionException(
72                  messagesProvider.getMessage( "InplaceMojo.missingWar", warSourceDirectory.getPath() ) );
73          }
74      }
75  }