1 package org.apache.tomcat.maven.plugin.tomcat7.run;
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 java.io.File;
23
24 /**
25 * Runs the current project as a packaged web application using an embedded Tomcat server.
26 *
27 * @requiresDependencyResolution runtime
28 * @author Mark Hobson <markhobson@gmail.com>
29 * @version $Id: AbstractRunWarMojo.html 1305321 2012-03-26 12:01:12Z olamy $
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 expression = "${project.build.directory}/${project.build.finalName}"
43 * @required
44 */
45 private File warDirectory;
46
47 /**
48 * The path of the Tomcat context XML file.
49 *
50 * @parameter expression =
51 * "${project.build.directory}/${project.build.finalName}/META-INF/context.xml"
52 */
53 private File contextFile;
54
55 // ----------------------------------------------------------------------
56 // AbstractRunMojo Implementation
57 // ----------------------------------------------------------------------
58
59 /**
60 * {@inheritDoc}
61 */
62 @Override
63 protected File getDocBase()
64 {
65 return warDirectory;
66 }
67
68 /**
69 * {@inheritDoc}
70 */
71 @Override
72 protected File getContextFile()
73 {
74 return contextFile;
75 }
76 }