org.apache.tomcat.maven.plugin.tomcat6.RunMojo Maven / Gradle / Ivy
package org.apache.tomcat.maven.plugin.tomcat6;
/*
* 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.catalina.Context;
import org.apache.catalina.loader.WebappLoader;
import org.apache.catalina.startup.Embedded;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Execute;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.tomcat.maven.common.run.ClassLoaderEntriesCalculator;
import org.apache.tomcat.maven.common.run.ClassLoaderEntriesCalculatorRequest;
import org.apache.tomcat.maven.common.run.ClassLoaderEntriesCalculatorResult;
import org.apache.tomcat.maven.common.run.TomcatRunException;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.codehaus.plexus.util.xml.Xpp3DomBuilder;
import org.codehaus.plexus.util.xml.Xpp3DomWriter;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.StringWriter;
import java.util.List;
import java.util.Set;
/**
* Runs the current project as a dynamic web application using an embedded Tomcat server.
*
* @author Jurgen Lust
* @author Mark Hobson
*/
@Mojo( name = "run", requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true )
@Execute( phase = LifecyclePhase.PROCESS_CLASSES )
public class RunMojo
extends AbstractRunMojo
{
// ----------------------------------------------------------------------
// Mojo Parameters
// ----------------------------------------------------------------------
/**
* The set of dependencies for the web application being run.
*/
@Parameter( defaultValue = "${project.artifacts}", required = true, readonly = true )
private Set dependencies;
/**
* The web resources directory for the web application being run.
*/
@Parameter( defaultValue = "${basedir}/src/main/webapp", property = "tomcat.warSourceDirectory" )
private File warSourceDirectory;
/**
* Set the "follow standard delegation model" flag used to configure our ClassLoader.
*
* @see http://tomcat.apache.org/tomcat-6.0-doc/api/org/apache/catalina/loader/WebappLoader.html#setDelegate(boolean)
* @since 1.0
*/
@Parameter( property = "tomcat.delegate", defaultValue = "true" )
private boolean delegate = true;
/**
* @since 2.0
*/
@Component( role = ClassLoaderEntriesCalculator.class )
private ClassLoaderEntriesCalculator classLoaderEntriesCalculator;
/**
* will add /WEB-INF/lib/*.jar and /WEB-INF/classes from war dependencies in the webappclassloader
*
* @since 2.0
*/
@Parameter( property = "maven.tomcat.addWarDependenciesInClassloader", defaultValue = "true" )
private boolean addWarDependenciesInClassloader;
/**
* will use the test classpath rather than the compile one and will add test dependencies too
*
* @since 2.0
*/
@Parameter( property = "maven.tomcat.useTestClasspath", defaultValue = "false" )
private boolean useTestClasspath;
/**
* Additional optional directories to add to the embedded tomcat classpath.
*
* @since 2.0-beta-1
*/
@Parameter( alias = "additionalClassesDirs" )
private List additionalClasspathDirs;
// ----------------------------------------------------------------------
// AbstractRunMojo Implementation
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*
* @throws MojoExecutionException
*/
@Override
protected Context createContext( Embedded container )
throws IOException, MojoExecutionException
{
Context context = super.createContext( container );
context.setReloadable( isContextReloadable() );
return context;
}
/**
* {@inheritDoc}
*
* @throws MojoExecutionException
*/
@Override
protected WebappLoader createWebappLoader()
throws IOException, MojoExecutionException
{
WebappLoader loader = super.createWebappLoader();
if ( useSeparateTomcatClassLoader )
{
loader.setDelegate( delegate );
}
try
{
ClassLoaderEntriesCalculatorRequest request =
new ClassLoaderEntriesCalculatorRequest().setDependencies( dependencies ).setLog(
getLog() ).setMavenProject( project ).setAddWarDependenciesInClassloader(
addWarDependenciesInClassloader ).setUseTestClassPath( useTestClasspath );
ClassLoaderEntriesCalculatorResult classLoaderEntriesCalculatorResult =
classLoaderEntriesCalculator.calculateClassPathEntries( request );
List classLoaderEntries = classLoaderEntriesCalculatorResult.getClassPathEntries();
final List tmpDirectories = classLoaderEntriesCalculatorResult.getTmpDirectories();
Runtime.getRuntime().addShutdownHook( new Thread()
{
@Override
public void run()
{
for ( File tmpDir : tmpDirectories )
{
try
{
FileUtils.deleteDirectory( tmpDir );
}
catch ( IOException e )
{
// ignore
}
}
}
} );
if ( classLoaderEntries != null )
{
for ( String classLoaderEntry : classLoaderEntries )
{
loader.addRepository( classLoaderEntry );
}
}
if ( additionalClasspathDirs != null && !additionalClasspathDirs.isEmpty() )
{
for ( String additionalClasspathDir : additionalClasspathDirs )
{
if ( StringUtils.isNotBlank( additionalClasspathDir ) )
{
File file = new File( additionalClasspathDir );
if ( file.exists() )
{
String fileUri = file.toURI().toString();
getLog().debug( "add file:" + fileUri + " as a additionalClasspathDir" );
loader.addRepository( fileUri );
}
}
}
}
}
catch ( TomcatRunException e )
{
throw new MojoExecutionException( e.getMessage(), e );
}
return loader;
}
/**
* {@inheritDoc}
*/
@Override
protected File getDocBase()
{
return warSourceDirectory;
}
/**
* {@inheritDoc}
*/
@Override
protected File getContextFile()
throws MojoExecutionException
{
File temporaryContextFile = null;
//----------------------------------------------------------------------------
// context attributes backgroundProcessorDelay reloadable cannot be modified at runtime.
// It looks only values from the file ared used
// so here we create a temporary file with values modified
//----------------------------------------------------------------------------
FileReader fr = null;
FileWriter fw = null;
StringWriter sw = new StringWriter();
try
{
temporaryContextFile = File.createTempFile( "tomcat-maven-plugin", "temp-ctx-file" );
temporaryContextFile.deleteOnExit();
fw = new FileWriter( temporaryContextFile );
// format to modify/create
if ( contextFile != null && contextFile.exists() )
{
fr = new FileReader( contextFile );
Xpp3Dom xpp3Dom = Xpp3DomBuilder.build( fr );
xpp3Dom.setAttribute( "backgroundProcessorDelay", Integer.toString( backgroundProcessorDelay ) );
xpp3Dom.setAttribute( "reloadable", Boolean.toString( isContextReloadable() ) );
Xpp3DomWriter.write( fw, xpp3Dom );
Xpp3DomWriter.write( sw, xpp3Dom );
getLog().debug( " generated context file " + sw.toString() );
}
else
{
if ( contextReloadable )
{
// don't care about using a complicated xml api to create one xml line :-)
StringBuilder sb = new StringBuilder( " © 2015 - 2025 Weber Informatics LLC | Privacy Policy