View Javadoc

1   package org.apache.tomcat.maven.plugin.tomcat7.deploy;
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  import org.apache.tomcat.maven.common.deployer.TomcatManagerException;
26  import org.apache.tomcat.maven.plugin.tomcat7.AbstractWarCatalinaMojo;
27  
28  import java.io.IOException;
29  
30  /**
31   * Undeploy a WAR from Tomcat.
32   *
33   * @since 2.1
34   */
35  @Mojo( name = "undeploy" )
36  public class UndeployMojo
37      extends AbstractWarCatalinaMojo
38  {
39      // ----------------------------------------------------------------------
40      // Mojo Parameters
41      // ----------------------------------------------------------------------
42  
43      /**
44       * Whether to fail the build if the web application cannot be undeployed.
45       */
46      @Parameter( property = "maven.tomcat.failOnError", defaultValue = "true" )
47      private boolean failOnError;
48  
49      // ----------------------------------------------------------------------
50      // Protected Methods
51      // ----------------------------------------------------------------------
52  
53      /**
54       * {@inheritDoc}
55       */
56      @Override
57      protected void invokeManager()
58          throws MojoExecutionException, TomcatManagerException, IOException
59      {
60          getLog().info( messagesProvider.getMessage( "UndeployMojo.undeployingApp", getDeployedURL() ) );
61  
62          try
63          {
64              log( getManager().undeploy( getPath() ).getHttpResponseBody() );
65          }
66          catch ( TomcatManagerException e )
67          {
68              if ( failOnError )
69              {
70                  throw e;
71              }
72  
73              getLog().warn( messagesProvider.getMessage( "UndeployMojo.undeployError", e.getMessage() ) );
74          }
75      }
76  
77  }