org.fabric3.maven.archive.MavenHelper Maven / Gradle / Ivy
/*
* Fabric3
* Copyright (c) 2009 Metaform Systems
*
* Fabric3 is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version, with the
* following exception:
*
* Linking this software statically or dynamically with other
* modules is making a combined work based on this software.
* Thus, the terms and conditions of the GNU General Public
* License cover the whole combination.
*
* As a special exception, the copyright holders of this software
* give you permission to link this software with independent
* modules to produce an executable, regardless of the license
* terms of these independent modules, and to copy and distribute
* the resulting executable under terms of your choice, provided
* that you also meet, for each linked independent module, the
* terms and conditions of the license of that module. An
* independent module is a module which is not derived from or
* based on this software. If you modify this software, you may
* extend this exception to your version of the software, but
* you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version.
*
* Fabric3 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
* You should have received a copy of the
* GNU General Public License along with Fabric3.
* If not, see remoteRepositories = new LinkedList();
/**
* TODO Make use of mirrors in Artifact resolution (when remote repositories are unavailable Remote artifact mirrors
*/
private List remoteMirrors = new LinkedList();
/**
* Artifact resolver
*/
private ArtifactResolver artifactResolver;
/**
* Online
*/
private boolean online;
/**
* Initialize the remote repository URLs.
*
* @param remoteRepositoryUrl Remote repository URLS.
* @param online whether the runtime is online or not
*/
public MavenHelper(String remoteRepositoryUrl, boolean online) {
this.remoteRepositoryUrls = remoteRepositoryUrl.split(",");
this.online = online;
}
/**
* Starts the embedder.
*
* @throws Fabric3DependencyException If unable to start the embedder.
*/
public void start() throws Fabric3DependencyException {
try {
Embedder embedder = new Embedder();
ClassWorld classWorld = new ClassWorld();
classWorld.newRealm("plexus.fabric", getClass().getClassLoader());
// Evil hack for Tomcat classloader issue - starts
Field realmsField = ClassWorld.class.getDeclaredField("realms");
realmsField.setAccessible(true);
Map realms = (Map) realmsField.get(classWorld);
DefaultClassRealm realm = (DefaultClassRealm) realms.get("plexus.fabric");
Class clazz = Class.forName("org.codehaus.classworlds.RealmClassLoader");
Constructor ctr = clazz.getDeclaredConstructor(DefaultClassRealm.class, ClassLoader.class);
ctr.setAccessible(true);
Object realmClassLoader = ctr.newInstance(realm, getClass().getClassLoader());
Field realmClassLoaderField = DefaultClassRealm.class.getDeclaredField("classLoader");
realmClassLoaderField.setAccessible(true);
realmClassLoaderField.set(realm, realmClassLoader);
// Evil hack for Tomcat classloader issue - ends
embedder.start(classWorld);
metadataSource = (ArtifactMetadataSource) embedder.lookup(ArtifactMetadataSource.ROLE);
artifactFactory = (ArtifactFactory) embedder.lookup(ArtifactFactory.ROLE);
artifactResolver = (ArtifactResolver) embedder.lookup(ArtifactResolver.ROLE);
setUpRepositories(embedder);
embedder.stop();
} catch (DuplicateRealmException ex) {
throw new Fabric3DependencyException(ex);
} catch (PlexusContainerException ex) {
throw new Fabric3DependencyException(ex);
} catch (ComponentLookupException ex) {
throw new Fabric3DependencyException(ex);
} catch (NoSuchFieldException ex) {
throw new Fabric3DependencyException(ex);
} catch (IllegalAccessException ex) {
throw new Fabric3DependencyException(ex);
} catch (ClassNotFoundException ex) {
throw new Fabric3DependencyException(ex);
} catch (NoSuchMethodException ex) {
throw new Fabric3DependencyException(ex);
} catch (InstantiationException ex) {
throw new Fabric3DependencyException(ex);
} catch (InvocationTargetException ex) {
throw new Fabric3DependencyException(ex);
}
}
/**
* Stops the embedder.
*
* @throws Fabric3DependencyException If unable to stop the embedder.
*/
public void stop() throws Fabric3DependencyException {
}
/**
* Resolves the dependencies transitively.
*
* @param rootArtifact Artifact whose dependencies need to be resolved.
* @return true if the artifact was succesfully resolved
* @throws Fabric3DependencyException If unable to resolve the dependencies.
*/
public boolean resolveTransitively(Artifact rootArtifact) throws Fabric3DependencyException {
org.apache.maven.artifact.Artifact mavenRootArtifact;
mavenRootArtifact = artifactFactory.createArtifact(rootArtifact.getGroup(),
rootArtifact.getName(),
rootArtifact.getVersion(),
SCOPE_RUNTIME,
rootArtifact.getType());
try {
if (resolve(mavenRootArtifact)) {
rootArtifact.setUrl(mavenRootArtifact.getFile().toURL());
return resolveDependencies(rootArtifact, mavenRootArtifact);
} else {
return false;
}
} catch (MalformedURLException ex) {
throw new Fabric3DependencyException(ex);
}
}
/*
* Resolves the artifact.
*/
private boolean resolve(org.apache.maven.artifact.Artifact mavenRootArtifact) {
try {
artifactResolver.resolve(mavenRootArtifact, remoteRepositories, localRepository);
return true;
} catch (ArtifactResolutionException ex) {
return false;
} catch (ArtifactNotFoundException ex) {
return false;
}
}
/*
* Sets up local and remote repositories.
*/
private void setUpRepositories(Embedder embedder) {
try {
ArtifactRepositoryFactory artifactRepositoryFactory =
(ArtifactRepositoryFactory) embedder.lookup(ArtifactRepositoryFactory.ROLE);
ArtifactRepositoryLayout layout =
(ArtifactRepositoryLayout) embedder.lookup(ArtifactRepositoryLayout.ROLE, "default");
String updatePolicy =
online ? ArtifactRepositoryPolicy.UPDATE_POLICY_ALWAYS : ArtifactRepositoryPolicy.UPDATE_POLICY_NEVER;
ArtifactRepositoryPolicy snapshotsPolicy =
new ArtifactRepositoryPolicy(true, updatePolicy, ArtifactRepositoryPolicy.CHECKSUM_POLICY_WARN);
ArtifactRepositoryPolicy releasesPolicy =
new ArtifactRepositoryPolicy(true, updatePolicy, ArtifactRepositoryPolicy.CHECKSUM_POLICY_WARN);
MavenSettingsBuilder settingsBuilder = (MavenSettingsBuilder) embedder.lookup(MavenSettingsBuilder.ROLE);
Settings settings = settingsBuilder.buildSettings();
String localRepo = settings.getLocalRepository();
localRepository = artifactRepositoryFactory.createArtifactRepository("local",
new File(localRepo).toURI().toURL().toString(),
layout,
snapshotsPolicy,
releasesPolicy);
if (online) {
setupRemoteRepositories(settings, artifactRepositoryFactory, layout, snapshotsPolicy, releasesPolicy);
setupMirrors(settings, artifactRepositoryFactory, layout, snapshotsPolicy, releasesPolicy);
}
} catch (Exception ex) {
throw new Fabric3DependencyException(ex);
}
}
/**
* Read remote repository URLs from settings and create artifact repositories
*
* @param settings
* @param artifactRepositoryFactory
* @param layout
* @param snapshotsPolicy
* @param releasesPolicy
*/
private void setupRemoteRepositories(
Settings settings,
ArtifactRepositoryFactory artifactRepositoryFactory,
ArtifactRepositoryLayout layout,
ArtifactRepositoryPolicy snapshotsPolicy,
ArtifactRepositoryPolicy releasesPolicy) {
// Read repository urls from settings file
List repositoryUrls = resolveActiveProfileRepositories(settings);
repositoryUrls.addAll(Arrays.asList(remoteRepositoryUrls));
for (String remoteRepositoryUrl : repositoryUrls) {
remoteRepositories.add(
createArtifactRepository(
remoteRepositoryUrl,
artifactRepositoryFactory,
layout,
snapshotsPolicy,
releasesPolicy
)
);
}
}
/**
* Read mirror URLs from settings and create artifact repositories
*
* @param settings
* @param artifactRepositoryFactory
* @param layout
* @param snapshotsPolicy
* @param releasesPolicy
*/
private void setupMirrors(
Settings settings,
ArtifactRepositoryFactory artifactRepositoryFactory,
ArtifactRepositoryLayout layout,
ArtifactRepositoryPolicy snapshotsPolicy,
ArtifactRepositoryPolicy releasesPolicy) {
List mirrorUrls = resolveMirrorUrls(settings);
for (String mirrorUrl : mirrorUrls) {
remoteMirrors.add(
createArtifactRepository(
mirrorUrl,
artifactRepositoryFactory,
layout,
snapshotsPolicy,
releasesPolicy
)
);
}
}
/**
* Creates an ArtifactFactory
*
* @param repositoryUrl
* @return
*/
private static ArtifactRepository createArtifactRepository(
String repositoryUrl,
ArtifactRepositoryFactory artifactRepositoryFactory,
ArtifactRepositoryLayout layout,
ArtifactRepositoryPolicy snapshotsPolicy,
ArtifactRepositoryPolicy releasesPolicy) {
String repositoryId = convertUrlToRepositoryId(repositoryUrl);
return
artifactRepositoryFactory.createArtifactRepository(
repositoryId,
repositoryUrl,
layout,
snapshotsPolicy,
releasesPolicy);
}
/**
* Converts a repository URL into a repository id
*
* @param remoteRepositoryUrl a repository URL
* @return repository id
*/
private static String convertUrlToRepositoryId(String remoteRepositoryUrl) {
assert remoteRepositoryUrl != null : "remoteRepositoryUrl cannot be null";
String repoid = remoteRepositoryUrl.replace(':', '_');
repoid = repoid.replace('/', '_');
repoid = repoid.replace('\\', '_');
return repoid;
}
/**
* Construct a list of repositories from any active profiles
*
* @param settings The Maven settings to be used
* @return List of remote repositories in order of precedence
*/
// Suppress Warnings for conversion from raw types
@SuppressWarnings("unchecked")
private List resolveActiveProfileRepositories(Settings settings) {
List repositories = new ArrayList();
Map profilesMap = (Map) settings.getProfilesAsMap();
for (Object nextProfileId : settings.getActiveProfiles()) {
Profile nextProfile = profilesMap.get((String) nextProfileId);
if (nextProfile.getRepositories() != null) {
for (Object repository : nextProfile.getRepositories()) {
String url = ((Repository) repository).getUrl();
repositories.add(url);
}
}
}
return repositories;
}
/**
* Construct a list of mirror urls from the maven settings
*
* @param settings The Maven settings to be used
* @return List of mirror urls
*/
// Suppress Warnings for conversion from raw types
@SuppressWarnings("unchecked")
private List resolveMirrorUrls(Settings settings) {
List mirrorUrls = new ArrayList();
List mirrors = (List) settings.getMirrors();
for (Mirror mirror : mirrors) {
mirrorUrls.add(mirror.getUrl());
}
return mirrorUrls;
}
/*
* Resolves transitive dependencies.
*/
private boolean resolveDependencies(Artifact rootArtifact, org.apache.maven.artifact.Artifact mavenRootArtifact) {
try {
ResolutionGroup resolutionGroup = null;
ArtifactResolutionResult result = null;
resolutionGroup = metadataSource.retrieve(mavenRootArtifact, localRepository, remoteRepositories);
result = artifactResolver.resolveTransitively(resolutionGroup.getArtifacts(),
mavenRootArtifact,
remoteRepositories,
localRepository,
metadataSource);
// Add the artifacts to the deployment unit
for (Object obj : result.getArtifacts()) {
org.apache.maven.artifact.Artifact depArtifact = (org.apache.maven.artifact.Artifact) obj;
Artifact artifact = new Artifact();
artifact.setName(depArtifact.getArtifactId());
artifact.setGroup(depArtifact.getGroupId());
artifact.setType(depArtifact.getType());
artifact.setVersion(depArtifact.getVersion());
artifact.setClassifier(depArtifact.getClassifier());
artifact.setUrl(depArtifact.getFile().toURL());
rootArtifact.addDependency(artifact);
}
} catch (ArtifactMetadataRetrievalException ex) {
return false;
} catch (MalformedURLException ex) {
throw new Fabric3DependencyException(ex);
} catch (ArtifactResolutionException ex) {
return false;
} catch (ArtifactNotFoundException ex) {
return false;
}
return true;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy