View Javadoc

1   package org.apache.tomcat.maven.plugin.tomcat7;
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  /**
25   * Abstract goal that provides common configuration for Catalina-based goals.
26   *
27   * @author Mark Hobson <markhobson@gmail.com>
28   * @version $Id: AbstractWarCatalinaMojo.html 1305321 2012-03-26 12:01:12Z olamy $
29   */
30  public abstract class AbstractWarCatalinaMojo
31      extends AbstractCatalinaMojo
32  {
33      // ----------------------------------------------------------------------
34      // Mojo Parameters
35      // ----------------------------------------------------------------------
36  
37      /**
38       * The packaging of the Maven project that this goal operates upon.
39       *
40       * @parameter expression = "${project.packaging}"
41       * @required
42       * @readonly
43       */
44      private String packaging;
45  
46      /**
47       * If set to true ignore if packaging of project is not 'war'.
48       *
49       * @parameter expression="${tomcat.ignorePackaging}" default-value="false"
50       * @since 1.1
51       */
52      private boolean ignorePackaging;
53  
54      // ----------------------------------------------------------------------
55      // Mojo Implementation
56      // ----------------------------------------------------------------------
57  
58      /**
59       * {@inheritDoc}
60       */
61      @Override
62      public void execute()
63          throws MojoExecutionException
64      {
65          if ( !isWar() )
66          {
67              getLog().info( messagesProvider.getMessage( "AbstractWarCatalinaMojo.nonWar" ) );
68              return;
69          }
70  
71          super.execute();
72      }
73  
74      // ----------------------------------------------------------------------
75      // Protected Methods
76      // ----------------------------------------------------------------------
77  
78      /**
79       * Gets whether this project uses WAR packaging.
80       *
81       * @return whether this project uses WAR packaging
82       */
83      protected boolean isWar()
84      {
85          return "war".equals( packaging ) || ignorePackaging;
86      }
87  }