org.kuali.common.util.RepositoryUtils Maven / Gradle / Ivy
/**
* Copyright 2010-2013 The Kuali Foundation
*
* Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
*
* 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.kuali.common.util;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.kuali.common.util.nullify.NullUtils;
public class RepositoryUtils {
private static final String FS = File.separator;
private static final String DEFAULT_MAVEN_REPO_PATH = ".m2" + FS + "repository";
private static final String GAV_DELIMITER = ":";
public static final void copyArtifact(String repository, Artifact artifact) {
File file = getFile(artifact);
copyArtifactToFile(repository, artifact, file);
}
public static final void copyArtifactToDirectory(String repository, Artifact artifact, File directory) {
String filename = getFilename(artifact);
File file = new File(directory, filename);
copyArtifactToFile(repository, artifact, file);
}
public static final void copyArtifactToFile(String repository, Artifact artifact, File file) {
String location = repository + getRepositoryPath(artifact);
LocationUtils.copyLocationToFile(location, file);
}
/**
*
* Order is groupId:artifactId:version:classifier:type. The ordering here matches the order Maven uses to create actual files. Which is different from what the
* toString() method on Maven's Artifact object produces.
*
*
*
* Trailing :'s are omitted.
*
*
*
* If every field is left blank, :::: is returned.
*
*
*
* org.kuali.common:kuali-jdbc:1.0.0:webapp:jar - groupId + artifactId + version + classifier + type
* org.kuali.common:kuali-jdbc:1.0.0::jar - no classifier
* :::: - Every field is blank
* org.kuali.common - groupId only
* ::::jar - type only
* :kuali-jdbc:::jar - no groupId, version, classifier, or type
* org.kuali.common:kuali-jdbc - groupId + artifactId
* org.kuali.common:kuali-jdbc:1.0.0 - groupId + artifactId + version
* org.kuali.common:kuali-jdbc:1.0.0:webapp - no type
* org.kuali.common:kuali-jdbc:1.0.0 - no classifier or type
* org.kuali.common:kuali-jdbc::webapp:jar - no version
*
*/
public static final String toString(Artifact artifact) {
List tokens = new ArrayList();
tokens.add(toEmpty(artifact.getGroupId()));
tokens.add(toEmpty(artifact.getArtifactId()));
tokens.add(toEmpty(artifact.getVersion()));
tokens.add(toEmpty(artifact.getClassifier()));
tokens.add(toEmpty(artifact.getType()));
int delimiterCount = getDelimiterCount(tokens);
return getDelimitedString(tokens, delimiterCount, GAV_DELIMITER);
}
/**
*
* Order is groupId:artifactId:version:classifier:type:scope. The ordering here matches the order Maven uses to create actual files. As opposed to what the
* toString() method on Maven's Dependency object produces.
*
*
*
* Trailing :'s are omitted.
*
*
*
* If every field is left blank, ::::: is returned.
*
*
*
* org.kuali.common:kuali-jdbc:1.0.0:webapp:jar:compile - groupId + artifactId + version + classifier + type + scope
* org.kuali.common:kuali-jdbc:1.0.0::jar:compile - no classifier
* org.kuali.common:kuali-jdbc:1.0.0:webapp:jar: - no scope
* ::::: - Every field is blank
* org.kuali.common - groupId only
* :::::compile - scope only
* :kuali-jdbc:::jar - artifactId + type
* org.kuali.common:kuali-jdbc - groupId + artifactId
* org.kuali.common:kuali-jdbc:1.0.0 - groupId + artifactId + version
* org.kuali.common:kuali-jdbc:1.0.0:webapp - groupId + artifactId + version + classifier
* org.kuali.common:kuali-jdbc:1.0.0:::compile - no classifier or type
* org.kuali.common:kuali-jdbc::webapp:jar:compile - no version
*
*/
public static final String toString(Dependency dependency) {
List tokens = new ArrayList();
tokens.add(toEmpty(dependency.getGroupId()));
tokens.add(toEmpty(dependency.getArtifactId()));
tokens.add(toEmpty(dependency.getVersion()));
tokens.add(toEmpty(dependency.getClassifier()));
tokens.add(toEmpty(dependency.getType()));
tokens.add(toEmpty(dependency.getScope()));
int delimiterCount = getDelimiterCount(tokens);
return getDelimitedString(tokens, delimiterCount, GAV_DELIMITER);
}
/**
*
* Order is groupId:artifactId:version:classifier:type:scope.
*
*/
public static final Artifact parseArtifact(String gav) {
Assert.hasText(gav, "gav has no text");
String[] tokens = StringUtils.splitPreserveAllTokens(gav, GAV_DELIMITER);
int len = tokens.length;
for (int i = 0; i < len; i++) {
tokens[i] = toNull(tokens[i]);
}
Artifact a = new Artifact();
if (len > 0) {
a.setGroupId(tokens[0]);
}
if (len > 1) {
a.setArtifactId(tokens[1]);
}
if (len > 2) {
a.setVersion(tokens[2]);
}
if (len > 3) {
a.setClassifier(tokens[3]);
}
if (len > 4) {
a.setType(tokens[4]);
}
return a;
}
/**
*
* Order is groupId:artifactId:version:classifier:type:scope.
*
*/
public static final Dependency parseDependency(String gav) {
Assert.hasText(gav, "gav has no text");
String[] tokens = StringUtils.splitPreserveAllTokens(gav, GAV_DELIMITER);
int len = tokens.length;
for (int i = 0; i < len; i++) {
tokens[i] = toNull(tokens[i]);
}
Dependency d = new Dependency();
if (len > 0) {
d.setGroupId(tokens[0]);
}
if (len > 1) {
d.setArtifactId(tokens[1]);
}
if (len > 2) {
d.setVersion(tokens[2]);
}
if (len > 3) {
d.setClassifier(tokens[3]);
}
if (len > 4) {
d.setType(tokens[4]);
}
if (len > 5) {
d.setScope(tokens[5]);
}
return d;
}
protected static final String getDelimitedString(List tokens, int delimiterCount, String delimiter) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < tokens.size(); i++) {
if (i != 0 && i < delimiterCount) {
sb.append(delimiter);
}
sb.append(tokens.get(i));
}
return sb.toString();
}
protected static final int getDelimiterCount(List tokens) {
int count = 0;
for (int i = 0; i < tokens.size(); i++) {
String token = toEmpty(tokens.get(i));
if (!StringUtils.isEmpty(token)) {
count = i + 1;
}
}
return count == 0 ? tokens.size() : count;
}
/**
* Return null if token is blank, "NULL", or "NONE"
*/
public static String toNull(String token) {
if (StringUtils.isBlank(token)) {
return null;
}
if (NullUtils.isNullOrNone(token)) {
return null;
}
return token;
}
/**
* Return the empty string if token is blank, "NULL", or "NONE"
*/
public static String toEmpty(String token) {
if (StringUtils.isBlank(token)) {
return "";
}
if (NullUtils.isNullOrNone(token)) {
return "";
}
return token;
}
public static final String getRepositoryPath(Artifact artifact) {
StringBuilder sb = new StringBuilder();
sb.append(Str.getPath(artifact.getGroupId()));
sb.append(FS);
sb.append(artifact.getArtifactId());
sb.append(FS);
sb.append(artifact.getVersion());
return sb.toString();
}
/**
* Return true if classifier should become part of the filename
*/
protected static boolean addClassifierToFilename(String classifier) {
return !StringUtils.isBlank(classifier) && !NullUtils.isNullOrNone(classifier);
}
public static final String getFilename(Artifact artifact) {
StringBuilder sb = new StringBuilder();
sb.append(artifact.getArtifactId());
sb.append("-");
sb.append(artifact.getVersion());
if (addClassifierToFilename(artifact.getClassifier())) {
sb.append("-");
sb.append(artifact.getClassifier());
}
sb.append(".");
sb.append(artifact.getType());
return sb.toString();
}
public static final File getDefaultLocalRepositoryDir() {
return new File(FileUtils.getUserDirectoryPath() + FS + DEFAULT_MAVEN_REPO_PATH);
}
public static final File getFile(Artifact artifact) {
return getFile(getDefaultLocalRepositoryDir(), artifact);
}
public static final File getFile(File localRepositoryDir, Artifact artifact) {
String path = getRepositoryPath(artifact);
String filename = getFilename(artifact);
return new File(localRepositoryDir.getAbsolutePath() + FS + path, filename);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy