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  import org.apache.maven.plugins.annotations.Mojo;
24  import org.apache.maven.plugins.annotations.Parameter;
25  
26  import java.io.File;
27  
28  /**
29   * Deploy a WAR in-place to Tomcat.
30   *
31   * @author Mark Hobson <markhobson@gmail.com>
32   * @todo depend on war:inplace when MNG-1649 resolved
33   */
34  @Mojo( name = "inplace" )
35  public class InplaceMojo
36      extends AbstractDeployMojo
37  {
38      // ----------------------------------------------------------------------
39      // Mojo Parameters
40      // ----------------------------------------------------------------------
41  
42      /**
43       * The path of the inplace WAR directory to deploy.
44       */
45      @Parameter( defaultValue = "${basedir}/src/main/webapp", required = true )
46      private File warSourceDirectory;
47  
48      // ----------------------------------------------------------------------
49      // Protected Methods
50      // ----------------------------------------------------------------------
51  
52      /**
53       * {@inheritDoc}
54       */
55      @Override
56      protected File getWarFile()
57      {
58          return warSourceDirectory;
59      }
60  
61      /**
62       * {@inheritDoc}
63       */
64      @Override
65      protected void validateWarFile()
66          throws MojoExecutionException
67      {
68          if ( !warSourceDirectory.exists() || !warSourceDirectory.isDirectory() )
69          {
70              throw new MojoExecutionException(
71                  messagesProvider.getMessage( "InplaceMojo.missingWar", warSourceDirectory.getPath() ) );
72          }
73      }
74  }