├── .gitignore
├── README.md
├── pom.xml
├── samples
    └── joda-time-in-jruby.rb
└── src
    ├── main
        └── java
        │   └── com
        │       └── bigfatgun
        │           └── MavenClassLoader.java
    └── test
        └── java
            └── com
                └── bigfatgun
                    └── MavenClassLoaderTest.java


/.gitignore:
--------------------------------------------------------------------------------
1 | .m2
2 | target
3 | *.iml
4 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | maven-classloader
 2 | ===
 3 | 
 4 | Load Any Class In The (Mavenized) World
 5 | ---
 6 | 
 7 | Given a [Maven][1] GAV, the Maven Classloader will resolve and download all dependencies from local and remote maven repositories.
 8 | 
 9 | This library utilizes [Sonatype Aether][2], the library used by Maven to deal with repositories. Aether does all of the heavy lifting, this library aims to be a lightweight shim on top of it to help reduce the friction for a majority of potential uses.
10 | 
11 | [1]: http://maven.apache.org/ "Apache Maven"
12 | [2]: http://aether.sonatype.org/ "Sonatype Aether Product Page"
13 | 
14 | ### Getting Started (Maven)
15 | 
16 | Until this is put into a maven repo, download source and build a `.jar` with Maven: `mvn clean install`
17 | 
18 | Add the following to your `pom.xml`:
19 | 
20 |     <dependency>
21 |         <groupId>com.bigfatgun</groupId>
22 |         <artifactId>maven-classloader</artifactId>
23 |         <version>1.0-SNAPSHOT</version>
24 |     </dependency>
25 | 
26 | Create a ClassLoader:
27 | 
28 |     ClassLoader classLoader = MavenClassloader.forGAV("junit:junit:4.8.1");
29 | 
30 | You're done! Assuming you wanted the classloader for a reason, such as loading a class, you just use normal reflection:
31 | 
32 |     Class<?> junitAssertClass = classLoader.loadClass("org.junit.Assert");
33 | 
34 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4 |     <modelVersion>4.0.0</modelVersion>
  5 |     <name>maven-classloader</name>
  6 |     <groupId>com.bigfatgun</groupId>
  7 |     <artifactId>maven-classloader</artifactId>
  8 |     <version>1.0-SNAPSHOT</version>
  9 |     <properties>
 10 |         <aetherVersion>1.13.1</aetherVersion>
 11 |         <mavenVersion>3.0.4</mavenVersion>
 12 |         <wagonVersion>2.2</wagonVersion>
 13 |     </properties>
 14 |     <dependencies>
 15 |         <dependency>
 16 |             <groupId>com.google.guava</groupId>
 17 |             <artifactId>guava</artifactId>
 18 |             <version>11.0.2</version>
 19 |         </dependency>
 20 |         <dependency>
 21 |             <groupId>org.sonatype.aether</groupId>
 22 |             <artifactId>aether-api</artifactId>
 23 |             <version>${aetherVersion}</version>
 24 |         </dependency>
 25 |         <dependency>
 26 |             <groupId>org.sonatype.aether</groupId>
 27 |             <artifactId>aether-util</artifactId>
 28 |             <version>${aetherVersion}</version>
 29 |         </dependency>
 30 |         <dependency>
 31 |             <groupId>org.sonatype.aether</groupId>
 32 |             <artifactId>aether-impl</artifactId>
 33 |             <version>${aetherVersion}</version>
 34 |             <exclusions>
 35 |                 <exclusion>
 36 |                     <groupId>com.google.collections</groupId>
 37 |                     <artifactId>google-collections</artifactId>
 38 |                 </exclusion>
 39 |             </exclusions>
 40 |         </dependency>
 41 |         <dependency>
 42 |             <groupId>org.sonatype.aether</groupId>
 43 |             <artifactId>aether-connector-wagon</artifactId>
 44 |             <version>${aetherVersion}</version>
 45 |             <exclusions>
 46 |                 <exclusion>
 47 |                     <groupId>com.google.collections</groupId>
 48 |                     <artifactId>google-collections</artifactId>
 49 |                 </exclusion>
 50 |                 <exclusion>
 51 |                     <groupId>junit</groupId>
 52 |                     <artifactId>junit</artifactId>
 53 |                 </exclusion>
 54 |             </exclusions>
 55 |         </dependency>
 56 |         <dependency>
 57 |             <groupId>org.apache.maven</groupId>
 58 |             <artifactId>maven-aether-provider</artifactId>
 59 |             <version>${mavenVersion}</version>
 60 |         </dependency>
 61 |         <dependency>
 62 |             <groupId>org.apache.maven.wagon</groupId>
 63 |             <artifactId>wagon-file</artifactId>
 64 |             <version>${wagonVersion}</version>
 65 |         </dependency>
 66 |         <dependency>
 67 |             <groupId>org.apache.maven.wagon</groupId>
 68 |             <artifactId>wagon-http-lightweight</artifactId>
 69 |             <version>${wagonVersion}</version>
 70 |             <exclusions>
 71 |                 <exclusion>
 72 |                     <groupId>commons-logging</groupId>
 73 |                     <artifactId>commons-logging</artifactId>
 74 |                 </exclusion>
 75 |                 <exclusion>
 76 |                     <groupId>nekohtml</groupId>
 77 |                     <artifactId>nekohtml</artifactId>
 78 |                 </exclusion>
 79 |                 <exclusion>
 80 |                     <groupId>nekohtml</groupId>
 81 |                     <artifactId>xercesMinimal</artifactId>
 82 |                 </exclusion>
 83 |             </exclusions>
 84 |         </dependency>
 85 |         <dependency>
 86 |             <groupId>junit</groupId>
 87 |             <artifactId>junit</artifactId>
 88 |             <version>4.10</version>
 89 |             <scope>test</scope>
 90 |         </dependency>
 91 |     </dependencies>
 92 |     <build>
 93 |         <plugins>
 94 |             <plugin>
 95 |                 <groupId>org.apache.maven.plugins</groupId>
 96 |                 <artifactId>maven-release-plugin</artifactId>
 97 |                 <version>2.1</version>
 98 |             </plugin>
 99 |             <plugin>
100 |                 <groupId>org.apache.maven.plugins</groupId>
101 |                 <artifactId>maven-shade-plugin</artifactId>
102 |                 <version>1.4</version>
103 |                 <executions>
104 |                     <execution>
105 |                         <phase>package</phase>
106 |                         <goals>
107 |                             <goal>shade</goal>
108 |                         </goals>
109 |                         <configuration>
110 |                             <artifactSet>
111 |                                 <excludes>
112 |                                 </excludes>
113 |                             </artifactSet>
114 |                             <transformers>
115 |                                 <transformer implementation="org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer"/>
116 |                             </transformers>
117 |                         </configuration>
118 |                     </execution>
119 |                 </executions>
120 |             </plugin>
121 |         </plugins>
122 |     </build>
123 |     <scm>
124 |         <connection>scm:git:git@github.com:year2013/maven-classloader.git</connection>
125 |         <url>scm:git:git@github.com:year2013/maven-classloader.git</url>
126 |         <developerConnection>scm:git:git@github.com:year2013/maven-classloader.git</developerConnection>
127 |     </scm>
128 | </project>
129 | 


--------------------------------------------------------------------------------
/samples/joda-time-in-jruby.rb:
--------------------------------------------------------------------------------
 1 | include Java
 2 | require "../target/maven-classloader-1.0-SNAPSHOT.jar"
 3 | include_class Java::com.bigfatgun.MavenClassLoader
 4 | 
 5 | @cl = MavenClassLoader.forGAV("joda-time:joda-time:1.6.2");
 6 | 
 7 | def dateTime()
 8 |   newInstanceOf("org.joda.time.DateTime")
 9 | end
10 | 
11 | def newInstanceOf(clsName)
12 |   @cl.loadClass(clsName).newInstance()
13 | end
14 | 
15 | # ruby date
16 | ruby_now = Time.now
17 | # joda date
18 | joda_now = dateTime()
19 | 
20 | puts "Ruby says it is #{ruby_now} and joda-time says it is #{joda_now}"
21 | 
22 | # ruby is duck-typed!
23 | hour_of_day = joda_now.hourOfDay();
24 | 


--------------------------------------------------------------------------------
/src/main/java/com/bigfatgun/MavenClassLoader.java:
--------------------------------------------------------------------------------
  1 | package com.bigfatgun;
  2 | 
  3 | import com.google.common.base.Function;
  4 | import com.google.common.base.Preconditions;
  5 | import com.google.common.base.Throwables;
  6 | import com.google.common.collect.ImmutableList;
  7 | import com.google.common.collect.Lists;
  8 | import org.apache.maven.repository.internal.MavenRepositorySystemSession;
  9 | import org.codehaus.plexus.DefaultPlexusContainer;
 10 | import org.codehaus.plexus.PlexusContainerException;
 11 | import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
 12 | import org.sonatype.aether.RepositorySystem;
 13 | import org.sonatype.aether.RepositorySystemSession;
 14 | import org.sonatype.aether.artifact.Artifact;
 15 | import org.sonatype.aether.collection.CollectRequest;
 16 | import org.sonatype.aether.collection.DependencyCollectionException;
 17 | import org.sonatype.aether.graph.Dependency;
 18 | import org.sonatype.aether.graph.DependencyNode;
 19 | import org.sonatype.aether.repository.LocalRepository;
 20 | import org.sonatype.aether.repository.RemoteRepository;
 21 | import org.sonatype.aether.resolution.ArtifactResolutionException;
 22 | import org.sonatype.aether.util.artifact.DefaultArtifact;
 23 | import org.sonatype.aether.util.graph.PreorderNodeListGenerator;
 24 | 
 25 | import java.io.File;
 26 | import java.net.MalformedURLException;
 27 | import java.net.URL;
 28 | import java.net.URLClassLoader;
 29 | import java.util.List;
 30 | 
 31 | public final class MavenClassLoader {
 32 | 
 33 |     public static class ClassLoaderBuilder {
 34 | 
 35 |         private static final String COMPILE_SCOPE = "compile";
 36 |         private static final ClassLoader SHARE_NOTHING = null;
 37 | 
 38 |         private final ImmutableList<RemoteRepository> repositories;
 39 |         private final File localRepositoryDirectory;
 40 | 
 41 |         private ClassLoaderBuilder(RemoteRepository... repositories) {
 42 |             Preconditions.checkNotNull(repositories);
 43 |             Preconditions.checkArgument(repositories.length > 0, "Must specify at least one remote repository.");
 44 | 
 45 |             this.repositories = ImmutableList.copyOf(repositories);
 46 |             this.localRepositoryDirectory = new File(".m2/repository");
 47 |         }
 48 | 
 49 |         public URLClassLoader forGAV(String gav) {
 50 |             try {
 51 |                 CollectRequest collectRequest = createCollectRequestForGAV(gav);
 52 |                 List<Artifact> artifacts = collectDependenciesIntoArtifacts(collectRequest);
 53 |                 List<URL> urls = Lists.newLinkedList();
 54 |                 for (Artifact artifact : artifacts) {
 55 |                     urls.add(artifact.getFile().toURI().toURL());
 56 |                 }
 57 | 
 58 |                 return new URLClassLoader(urls.toArray(new URL[urls.size()]), SHARE_NOTHING);
 59 |             } catch (Exception e) {
 60 |                 throw Throwables.propagate(e);
 61 |             }
 62 |         }
 63 | 
 64 |         private CollectRequest createCollectRequestForGAV(String gav) {
 65 |             Dependency dependency = new Dependency(new DefaultArtifact(gav), COMPILE_SCOPE);
 66 | 
 67 |             CollectRequest collectRequest = new CollectRequest();
 68 |             collectRequest.setRoot(dependency);
 69 |             for (RemoteRepository repository : repositories) {
 70 |                 collectRequest.addRepository(repository);
 71 |             }
 72 | 
 73 |             return collectRequest;
 74 |         }
 75 | 
 76 |         private List<Artifact> collectDependenciesIntoArtifacts(CollectRequest collectRequest)
 77 |                 throws PlexusContainerException, ComponentLookupException, DependencyCollectionException, ArtifactResolutionException {
 78 | 
 79 |             RepositorySystem repositorySystem = newRepositorySystem();
 80 |             RepositorySystemSession session = newSession(repositorySystem);
 81 |             DependencyNode node = repositorySystem.collectDependencies(session, collectRequest).getRoot();
 82 | 
 83 |             repositorySystem.resolveDependencies(session, node, null);
 84 | 
 85 |             PreorderNodeListGenerator nlg = new PreorderNodeListGenerator();
 86 |             node.accept(nlg);
 87 | 
 88 |             return nlg.getArtifacts(false);
 89 |         }
 90 | 
 91 |         private RepositorySystem newRepositorySystem() throws PlexusContainerException, ComponentLookupException {
 92 |             return new DefaultPlexusContainer().lookup(RepositorySystem.class);
 93 |         }
 94 | 
 95 |         private RepositorySystemSession newSession(RepositorySystem system) {
 96 |             MavenRepositorySystemSession session = new MavenRepositorySystemSession();
 97 | 
 98 |             LocalRepository localRepo = new LocalRepository(localRepositoryDirectory);
 99 |             session.setLocalRepositoryManager(system.newLocalRepositoryManager(localRepo));
100 | 
101 |             return session;
102 |         }
103 |     }
104 | 
105 |     /**
106 |      * Creates a classloader that will resolve artifacts against the default "central" repository. Throws
107 |      * {@link IllegalArgumentException} if the GAV is invalid, {@link NullPointerException} if the GAV is null.
108 |      *
109 |      * @param gav artifact group:artifact:version, i.e. joda-time:joda-time:1.6.2
110 |      * @return a classloader that can be used to load classes from the given artifact
111 |      */
112 |     public static URLClassLoader forGAV(String gav) {
113 |         return usingCentralRepo().forGAV(Preconditions.checkNotNull(gav));
114 |     }
115 | 
116 |     public static ClassLoaderBuilder usingCentralRepo() {
117 |         RemoteRepository central = new RemoteRepository("central", "default", "http://repo1.maven.org/maven2/");
118 |         return new ClassLoaderBuilder(central);
119 |     }
120 | }
121 | 


--------------------------------------------------------------------------------
/src/test/java/com/bigfatgun/MavenClassLoaderTest.java:
--------------------------------------------------------------------------------
 1 | package com.bigfatgun;
 2 | 
 3 | import com.google.common.collect.Multiset;
 4 | import org.junit.Test;
 5 | 
 6 | import java.lang.reflect.InvocationTargetException;
 7 | import java.lang.reflect.Method;
 8 | 
 9 | import static org.junit.Assert.assertNotNull;
10 | 
11 | public class MavenClassLoaderTest {
12 | 
13 |     @Test
14 |     public void jodaTime() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException {
15 |         String gav = "joda-time:joda-time:[1.6,)";
16 |         String className = "org.joda.time.chrono.BuddhistChronology";
17 |         ClassLoader loader = MavenClassLoader.forGAV(gav);
18 |         assertNotNull(loader);
19 |         Class<?> buddhistChronology = loader.loadClass(className);
20 |         assertNotNull(buddhistChronology);
21 |         Method factoryMethod = buddhistChronology.getMethod("getInstance");
22 |         assertNotNull(factoryMethod.invoke(null));
23 |     }
24 | 
25 |     @Test(expected = ClassNotFoundException.class)
26 |     public void jodaTimeClassLoaderDoesNotHaveMultiset() throws ClassNotFoundException {
27 |         String gav = "joda-time:joda-time:[1.6,)";
28 |         ClassLoader loader = MavenClassLoader.forGAV(gav);
29 |         assertNotNull(loader);
30 |         loader.loadClass(Multiset.class.getName());
31 |     }
32 | 
33 |     @Test(expected = IllegalArgumentException.class)
34 |     public void classLoaderConstructionFailsOnBogusGAV() {
35 |         MavenClassLoader.forGAV("this isn't going to work!");
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------