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