org.apache.karaf.tooling.utils.MavenUtil Maven / Gradle / Ivy
/*
* 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.
*/
package org.apache.karaf.tooling.utils;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.Date;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.layout.DefaultRepositoryLayout;
import org.apache.maven.artifact.repository.metadata.Metadata;
import org.apache.maven.artifact.repository.metadata.Snapshot;
import org.apache.maven.artifact.repository.metadata.SnapshotVersion;
import org.apache.maven.artifact.repository.metadata.Versioning;
import org.apache.maven.artifact.repository.metadata.io.xpp3.MetadataXpp3Writer;
import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.repository.RemoteRepository;
/**
* Util method for Maven manipulation (URL convert, metadata generation, etc).
*/
public class MavenUtil {
static final DefaultRepositoryLayout layout = new DefaultRepositoryLayout();
private static final Pattern aetherPattern = Pattern.compile("([^: ]+):([^: ]+)(:([^: ]*)(:([^: ]+))?)?:([^: ]+)");
private static final Pattern mvnPattern = Pattern.compile("(?:(?:wrap:)|(?:blueprint:))?mvn:([^/ ]+)/([^/ ]+)/([^/$ ]*)(/([^/$ ]+)(/([^/$ ]+))?)?(/\\$.+)?");
/**
* Convert PAX URL mvn format to aether coordinate format.
* N.B. we do not handle repository-url in mvn urls.
* N.B. version is required in mvn urls.
*
* @param name PAX URL mvn format: mvn-uri := [ 'wrap:' ] 'mvn:' [ repository-url '!' ] group-id '/' artifact-id [ '/' [version] [ '/' [type] [ '/' classifier ] ] ] ]
* @return aether coordinate format: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>
*/
public static String mvnToAether(String name) {
Matcher m = mvnPattern.matcher(name);
if (!m.matches()) {
return name;
}
StringBuilder b = new StringBuilder();
b.append(m.group(1)).append(":");//groupId
b.append(m.group(2)).append(":");//artifactId
String extension = m.group(5);
String classifier = m.group(7);
if (present(classifier)) {
if (present(extension)) {
b.append(extension).append(":");
} else {
b.append("jar:");
}
b.append(classifier).append(":");
} else {
if (present(extension) && !"jar".equals(extension)) {
b.append(extension).append(":");
}
}
b.append(m.group(3));
return b.toString();
}
/**
* Convert PAX URL mvn format to an aether Artifact.
* N.B. we do not handle repository-url in mvn urls.
* N.B. version is required in mvn urls.
*
* @param name PAX URL mvn format: mvn-uri := [ 'wrap:' ] 'mvn:' [ repository-url '!' ] group-id '/' artifact-id [ '/' [version] [ '/' [type] [ '/' classifier ] ] ] ]
* @return aether Artifact
*/
public static DefaultArtifact mvnToArtifact(String name) {
Matcher m = mvnPattern.matcher(name);
if (!m.matches()) {
return new DefaultArtifact(name);
}
String groupId = m.group(1);
String artifactId = m.group(2);
String version = m.group(3);
String extension = m.group(5);
if (!present(extension)) {
extension = "jar";
}
String classifier = m.group(7);
return new DefaultArtifact(groupId, artifactId, present(classifier) ? classifier : "", extension, version);
}
/**
* Convert Aether coordinate format to an aether Artifact.
* N.B. we do not handle repository-url in mvn urls.
* N.B. version is required in mvn urls.
*
* @param name aether coordinate format: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>
* @return aether Artifact
*/
public static DefaultArtifact aetherToArtifact(String name) {
Matcher m = aetherPattern.matcher(name);
if (!m.matches()) {
return new DefaultArtifact(name);
}
String groupId = m.group(1);
String artifactId = m.group(2);
String version = m.group(7);
String extension = m.group(4);
if (!present(extension)) {
extension = "jar";
}
String classifier = m.group(6);
return new DefaultArtifact(groupId, artifactId, present(classifier) ? classifier : "", extension, version);
}
private static boolean present(String part) {
return part != null && !part.isEmpty();
}
/**
* Convert Aether coordinate format to PAX mvn format.
* N.B. we do not handle repository-url in mvn urls.
* N.B. version is required in mvn urls.
*
* @param name aether coordinate format: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>
* @return PAX URL mvn format: mvn-uri := 'mvn:' [ repository-url '!' ] group-id '/' artifact-id [ '/' [version] [ '/' [type] [ '/' classifier ] ] ] ]
*/
public static String aetherToMvn(String name) {
Matcher m = aetherPattern.matcher(name);
if (!m.matches()) {
return name;
}
StringBuilder b = new StringBuilder("mvn:");
b.append(m.group(1)).append("/");//groupId
b.append(m.group(2)).append("/");//artifactId
b.append(m.group(7));//version
String extension = m.group(4);
String classifier = m.group(6);
if (present(classifier)) {
if (present(extension)) {
b.append("/").append(extension);
} else {
b.append("/jar");
}
b.append("/").append(classifier);
} else if (present(extension)) {
b.append("/").append(extension);
}
return b.toString();
}
public static boolean isEmpty(String classifier) {
return classifier == null || classifier.length() == 0;
}
/**
* Generate the maven-metadata-local.xml for the given Maven Artifact.
*
* @param artifact the Maven Artifact.
* @param target the target maven-metadata-local.xml file to generate.
* @throws IOException if the maven-metadata-local.xml can't be generated.
*/
public static void generateMavenMetadata(Artifact artifact, File target) throws IOException {
target.getParentFile().mkdirs();
Metadata metadata = new Metadata();
metadata.setGroupId(artifact.getGroupId());
metadata.setArtifactId(artifact.getArtifactId());
metadata.setVersion(artifact.getVersion());
metadata.setModelVersion("1.1.0");
Versioning versioning = new Versioning();
versioning.setLastUpdatedTimestamp(new Date(System.currentTimeMillis()));
Snapshot snapshot = new Snapshot();
snapshot.setLocalCopy(true);
versioning.setSnapshot(snapshot);
SnapshotVersion snapshotVersion = new SnapshotVersion();
snapshotVersion.setClassifier(artifact.getClassifier());
snapshotVersion.setVersion(artifact.getVersion());
snapshotVersion.setExtension(artifact.getType());
snapshotVersion.setUpdated(versioning.getLastUpdated());
versioning.addSnapshotVersion(snapshotVersion);
metadata.setVersioning(versioning);
MetadataXpp3Writer metadataWriter = new MetadataXpp3Writer();
Writer writer = new FileWriter(target);
metadataWriter.write(writer, metadata);
}
public static String getFileName(Artifact artifact, boolean timestampedSnapshot) {
if (timestampedSnapshot) {
return artifact.getArtifactId() + "-" + artifact.getVersion()
+ (artifact.getClassifier() != null ? "-" + artifact.getClassifier() : "") + "." + artifact.getType();
} else {
return artifact.getArtifactId() + "-" + artifact.getBaseVersion()
+ (artifact.getClassifier() != null ? "-" + artifact.getClassifier() : "") + "." + artifact.getType();
}
}
public static String getDir(Artifact artifact) {
return artifact.getGroupId().replace('.', '/') + "/" + artifact.getArtifactId() + "/" + artifact.getBaseVersion() + "/";
}
/**
* Changes maven configuration of remote repositories to a list of repositories for pax-url-aether
* @param remoteRepositories
* @return
*/
public static String remoteRepositoryList(List remoteRepositories) {
StringBuilder remotes = new StringBuilder();
for (RemoteRepository rr : remoteRepositories) {
if (remotes.length() > 0) {
remotes.append(",");
}
remotes.append(rr.getUrl());
remotes.append("@id=").append(rr.getId());
if (!rr.getPolicy(false).isEnabled()) {
remotes.append("@noreleases");
}
if (rr.getPolicy(true).isEnabled()) {
remotes.append("@snapshots");
}
}
return remotes.toString();
}
}