You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ni...@apache.org on 2009/05/18 15:01:47 UTC
svn commit: r775932 - in
/maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin:
classloader/ProjectClassLoader.java classloader/ProjectClassLoaderUtil.java
cli/JavaCommandBuilder.java
Author: nicolas
Date: Mon May 18 13:01:46 2009
New Revision: 775932
URL: http://svn.apache.org/viewvc?rev=775932&view=rev
Log:
ProjectClassLoader refactored as utility class
Added:
maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/classloader/ProjectClassLoaderUtil.java
Removed:
maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/classloader/ProjectClassLoader.java
Modified:
maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/cli/JavaCommandBuilder.java
Added: maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/classloader/ProjectClassLoaderUtil.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/classloader/ProjectClassLoaderUtil.java?rev=775932&view=auto
==============================================================================
--- maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/classloader/ProjectClassLoaderUtil.java (added)
+++ maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/classloader/ProjectClassLoaderUtil.java Mon May 18 13:01:46 2009
@@ -0,0 +1,202 @@
+package org.apache.maven.shared.plugin.classloader;
+
+/*
+ * 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 java.io.File;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.project.MavenProject;
+
+/**
+ * Helper class to build a ClassLoader from MavenProject artifacts and dependencies.
+ *
+ * @author <a href="mailto:nicolas@apache.org">Nicolas De Loof</a>
+ */
+public final class ProjectClassLoaderUtil
+{
+ private ProjectClassLoaderUtil()
+ {
+ // utility class
+ }
+
+ /**
+ * Create a ClassLoader for the project with the specified scope, optionnaly including sources
+ *
+ * @throws MalformedURLException
+ */
+ public static ClassLoader buildProjectClassLoader( MavenProject project, String scope, boolean includeSources )
+ throws MojoExecutionException
+ {
+ List urls = doBuildProjectClasspath( project, scope, includeSources );
+ URL[] classpath = (URL[]) urls.toArray( new URL[urls.size()] );
+ return new URLClassLoader( classpath );
+ }
+
+ /**
+ * Create a ClassLoader for the project with the specified scope, optionnaly including sources, and include the
+ * specified artifacts (typically from <code>${plugin.artifacts}</code>)
+ *
+ * @throws MalformedURLException
+ */
+ public static ClassLoader buildProjectClassLoaderWithArtifacts( MavenProject project, String scope,
+ boolean includeSources,
+ List additionalClassPathArtifacts )
+ throws MojoExecutionException
+ {
+ List urls = doBuildProjectClasspath( project, scope, includeSources );
+ for ( Iterator iterator = additionalClassPathArtifacts.iterator(); iterator.hasNext(); )
+ {
+ Artifact artifact = (Artifact) iterator.next();
+ try
+ {
+ urls.add( artifact.getFile().toURI().toURL() );
+ }
+ catch ( MalformedURLException e )
+ {
+ throw new MojoExecutionException( "Failed to resolve artifact " + artifact + " as URL", e );
+ }
+ }
+ URL[] classpath = (URL[]) urls.toArray( new URL[urls.size()] );
+ return new URLClassLoader( classpath );
+ }
+
+ /**
+ * Create a ClassLoader for the project with the specified scope, optionnaly including sources, and include the
+ * specified classpath elements.
+ *
+ * @throws MalformedURLException
+ */
+ public static ClassLoader buildProjectClassLoaderWithElements( MavenProject project, String scope,
+ boolean includeSources,
+ List additionalClassPathElements )
+ throws MojoExecutionException
+ {
+ List urls = doBuildProjectClasspath( project, scope, includeSources );
+ for ( Iterator iterator = additionalClassPathElements.iterator(); iterator.hasNext(); )
+ {
+ String path = (String) iterator.next();
+ try
+ {
+ urls.add( new File( path ).toURI().toURL() );
+ }
+ catch ( MalformedURLException e )
+ {
+ throw new MojoExecutionException( "Failed to resolve path " + path + " as URL", e );
+ }
+ }
+ URL[] classpath = (URL[]) urls.toArray( new URL[urls.size()] );
+ return new URLClassLoader( classpath );
+ }
+
+ private static List doBuildProjectClasspath( MavenProject project, String scope, boolean includeSources )
+ throws MojoExecutionException
+ {
+ List urls;
+ try
+ {
+ urls = buildProjectClasspath( project, scope, includeSources );
+ }
+ catch ( MalformedURLException e )
+ {
+ throw new MojoExecutionException( "Failed to resolve project dependencies as URL", e );
+ }
+ return urls;
+ }
+
+ /**
+ * @return Lis<URL> equivalent to the project Classpath
+ * @throws MalformedURLException
+ */
+ private static List buildProjectClasspath( MavenProject project, String scope, boolean includeSources )
+ throws MalformedURLException
+ {
+ List urls = new ArrayList();
+
+ File outputDirectory = new File( project.getBuild().getOutputDirectory() );
+ urls.add( outputDirectory.toURI().toURL() );
+ if ( includeSources )
+ {
+ List sourceRoots = project.getCompileSourceRoots();
+ for ( Iterator iterator = sourceRoots.iterator(); iterator.hasNext(); )
+ {
+ String sourceRoot = (String) iterator.next();
+ urls.add( new File( sourceRoot ).toURI().toURL() );
+ }
+ }
+
+ if ( scope.equals( Artifact.SCOPE_TEST ) )
+ {
+ File testOutputDirectory = new File( project.getBuild().getTestOutputDirectory() );
+ urls.add( testOutputDirectory.toURI().toURL() );
+ if ( includeSources )
+ {
+ List testSourceRoots = project.getTestCompileSourceRoots();
+ for ( Iterator iterator = testSourceRoots.iterator(); iterator.hasNext(); )
+ {
+ String testSourceRoot = (String) iterator.next();
+ urls.add( new File( testSourceRoot ).toURI().toURL() );
+ }
+ }
+ }
+
+ List artifacts = getArtifactsByScope( project, scope );
+ for ( Iterator iterator = artifacts.iterator(); iterator.hasNext(); )
+ {
+ Artifact artifact = (Artifact) iterator.next();
+ if ( !artifact.isResolved() )
+ {
+ throw new IllegalStateException( "Artifact is not resolved. \n"
+ + "Plugin must declare @requiresDependencyResolution " + scope );
+ }
+ urls.add( artifact.getFile().toURI().toURL() );
+ }
+
+ return urls;
+ }
+
+ public static List getArtifactsByScope( MavenProject project, String scope )
+ {
+ List artifacts;
+ if ( scope.equals( Artifact.SCOPE_COMPILE ) )
+ {
+ artifacts = project.getCompileArtifacts();
+ }
+ else if ( scope.equals( Artifact.SCOPE_RUNTIME ) )
+ {
+ artifacts = project.getRuntimeArtifacts();
+ }
+ else if ( scope.equals( Artifact.SCOPE_TEST ) )
+ {
+ artifacts = project.getTestArtifacts();
+ }
+ else
+ {
+ throw new IllegalArgumentException( "Usuported scope" + scope );
+ }
+ return artifacts;
+ }
+}
Modified: maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/cli/JavaCommandBuilder.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/cli/JavaCommandBuilder.java?rev=775932&r1=775931&r2=775932&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/cli/JavaCommandBuilder.java (original)
+++ maven/sandbox/trunk/shared/maven-plugin-helper/src/main/java/org/apache/maven/shared/plugin/cli/JavaCommandBuilder.java Mon May 18 13:01:46 2009
@@ -12,7 +12,7 @@
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
-import org.apache.maven.shared.plugin.classloader.ProjectClassLoader;
+import org.apache.maven.shared.plugin.classloader.ProjectClassLoaderUtil;
import org.codehaus.plexus.util.Os;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.cli.CommandLineException;
@@ -115,7 +115,7 @@
}
}
- List artifacts = ProjectClassLoader.getArtifactsByScope( project, scope );
+ List artifacts = ProjectClassLoaderUtil.getArtifactsByScope( project, scope );
for ( Iterator iterator = artifacts.iterator(); iterator.hasNext(); )
{
Artifact artifact = (Artifact) iterator.next();