View Javadoc
1   package org.apache.maven.plugins.war.packaging;
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.plugin.MojoFailureException;
24  import org.apache.maven.plugins.war.util.WebappStructureSerializer;
25  
26  import java.io.File;
27  import java.io.IOException;
28  
29  /**
30   * Saves the webapp structure cache.
31   *
32   * @author Stephane Nicoll
33   * @version $Id: SaveWebappStructurePostPackagingTask.java 1734135 2016-03-08 19:58:34Z khmarbaise $
34   */
35  public class SaveWebappStructurePostPackagingTask
36      implements WarPostPackagingTask
37  {
38  
39      private final File targetFile;
40  
41      private final WebappStructureSerializer serialier;
42  
43      /**
44       * @param targetFile {@link #targetFile}
45       */
46      public SaveWebappStructurePostPackagingTask( File targetFile )
47      {
48          this.targetFile = targetFile;
49          this.serialier = new WebappStructureSerializer();
50      }
51  
52      /**
53       * {@inheritDoc}
54       */
55      public void performPostPackaging( WarPackagingContext context )
56          throws MojoExecutionException, MojoFailureException
57      {
58          if ( targetFile == null )
59          {
60              context.getLog().debug( "Cache usage is disabled, not saving webapp structure." );
61          }
62          else
63          {
64              try
65              {
66                  serialier.toXml( context.getWebappStructure(), targetFile );
67                  context.getLog().debug( "Cache saved successfully." );
68              }
69              catch ( IOException e )
70              {
71                  throw new MojoExecutionException( "Could not save webapp structure", e );
72              }
73          }
74      }
75  }