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.plugins.annotations.Parameter;
23  
24  import java.io.File;
25  
26  /**
27   * Runs the current project as a packaged web application using an embedded Tomcat server.
28   *
29   * @author Mark Hobson <markhobson@gmail.com>
30   * @todo depend on war:exploded when MNG-1649 resolved
31   */
32  public abstract class AbstractRunWarMojo
33      extends AbstractRunMojo
34  {
35      // ----------------------------------------------------------------------
36      // Mojo Parameters
37      // ----------------------------------------------------------------------
38  
39      /**
40       * The path of the exploded WAR directory to run.
41       */
42      @Parameter( defaultValue = "${project.build.directory}/${project.build.finalName}", required = true )
43      private File warDirectory;
44  
45      /**
46       * The path of the Tomcat context XML file.
47       */
48      @Parameter( defaultValue = "${project.build.directory}/${project.build.finalName}/META-INF/context.xml" )
49      private File contextFile;
50  
51      // ----------------------------------------------------------------------
52      // AbstractRunMojo Implementation
53      // ----------------------------------------------------------------------
54  
55      /**
56       * {@inheritDoc}
57       */
58      @Override
59      protected File getDocBase()
60      {
61          return warDirectory;
62      }
63  
64      /**
65       * {@inheritDoc}
66       */
67      @Override
68      protected File getContextFile()
69      {
70          return contextFile;
71      }
72  }