org.apache.maven.plugins.war.packaging.SaveWebappStructurePostPackagingTask Maven / Gradle / Ivy

Go to download
package org.apache.maven.plugins.war.packaging;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.war.util.WebappStructureSerializer;

import java.io.File;
import java.io.IOException;

/**
 * Saves the webapp structure cache.
 *
 * @author Stephane Nicoll
 * @version $Id: SaveWebappStructurePostPackagingTask.java 1734135 2016-03-08 19:58:34Z khmarbaise $
 */
public class SaveWebappStructurePostPackagingTask
    implements WarPostPackagingTask
{

    private final File targetFile;

    private final WebappStructureSerializer serialier;

    /**
     * @param targetFile {@link #targetFile}
     */
    public SaveWebappStructurePostPackagingTask( File targetFile )
    {
        this.targetFile = targetFile;
        this.serialier = new WebappStructureSerializer();
    }

    /**
     * {@inheritDoc}
     */
    public void performPostPackaging( WarPackagingContext context )
        throws MojoExecutionException, MojoFailureException
    {
        if ( targetFile == null )
        {
            context.getLog().debug( "Cache usage is disabled, not saving webapp structure." );
        }
        else
        {
            try
            {
                serialier.toXml( context.getWebappStructure(), targetFile );
                context.getLog().debug( "Cache saved successfully." );
            }
            catch ( IOException e )
            {
                throw new MojoExecutionException( "Could not save webapp structure", e );
            }
        }
    }
}