org.apache.jackrabbit.filevault.maven.packaging.Dependency 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.jackrabbit.filevault.maven.packaging;
import java.io.IOException;
import javax.annotation.Nullable;
import org.apache.jackrabbit.filevault.maven.packaging.impl.PackageDependency;
import org.apache.jackrabbit.filevault.maven.packaging.impl.PackageInfo;
import org.apache.jackrabbit.vault.packaging.PackageId;
import org.apache.jackrabbit.vault.packaging.VersionRange;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.StringUtils;
/**
* The {@code Dependency} class represents a dependency to another content package.
* A dependency consists of a group name, a package name and a version range.
*
* A dependency is declared as a {@code } element of a list
* style {@code } element:
*
* <dependency>
* <group>theGroup</group>
* <name>theName</name>
* <version>1.5</version>
* </dependency>
*
*
* The dependency can also reference a maven project dependency, this is preferred
* as it yields to more robust builds.
*
* <dependency>
* <groupId>theGroup</groupId>
* <artifactId>theName</artifactId>
* </dependency>
*
*
* The {@code versionRange} may be indicated as a single version, in which
* case the version range has no upper bound and defines the minimal version
* accepted. Otherwise, the version range defines a lower and upper bound of
* accepted versions, where the bounds are either included using parentheses
* {@code ()} or excluded using brackets {@code []}
*/
public class Dependency {
/**
* The group name, required for package-id references
*/
private String group;
/**
* The group id, required for maven coordinate references
*/
private String groupId;
/**
* The package name, required for package-id references.
*/
private String name;
/**
* The artifact id, required for maven coordinate references
*/
private String artifactId;
/**
* The version range (optional)
*/
private String version;
/**
* Package information of this dependency. only available for maven referenced dependencies after {@link #resolve(MavenProject, Log)}
*/
private PackageInfo info;
/**
* Resolved package dependency. only available after {@link #resolve(MavenProject, Log)}
*/
private PackageDependency dependency;
/**
* Converts a list of {@link Dependency} instances to vault dependencies.
*
* @param log the Logger
* @param dependencyList The list of {@link Dependency} instances to convert.
* @return The Vault Packaging Dependency representing the dependencies.
*/
static PackageDependency[] resolve(final MavenProject project, final Log log, final Dependency... dependencyList) throws IOException {
PackageDependency[] dependencies = new PackageDependency[dependencyList.length];
for (int i = 0; i < dependencies.length; i++) {
dependencies[i] = dependencyList[i].resolve(project, log);
}
return dependencies;
}
/**
* Helper method for {@link #toString)} to convert an instance of this
* class to a Vault Packaging Dependency for easy string conversion.
*/
private PackageDependency resolve(final MavenProject project, final Log log) throws IOException {
if (!StringUtils.isEmpty(group) || !StringUtils.isEmpty(name)) {
log.warn("Using package id in dependencies is deprecated. use maven coordinates instead: " + group + ":" + name);
}
if (!StringUtils.isEmpty(groupId) && !StringUtils.isEmpty(artifactId)) {
for (Artifact a : project.getDependencyArtifacts()) {
if (a.getArtifactId().equals(artifactId) && a.getGroupId().equals(groupId)) {
PackageInfo info = PackageInfo.read(a.getFile());
if (info != null) {
PackageId id = info.getId();
group = id.getGroup();
name = id.getName();
if (StringUtils.isEmpty(version)) {
version = new VersionRange(id.getVersion(), true, null, false).toString();
}
this.info = info;
break;
} else {
throw new IOException("Specified dependency " + this + " is not a package.");
}
}
}
}
if (StringUtils.isEmpty(group) || StringUtils.isEmpty(name)) {
throw new IOException("Specified dependency " + this + " is not qualified.");
}
VersionRange range = StringUtils.isEmpty(version) ? VersionRange.INFINITE : VersionRange.fromString(version);
return dependency = new PackageDependency(group, name, range);
}
/**
* Returns the package info or {@code null}.
*
* @return the info.
*/
@Nullable
public PackageInfo getInfo() {
return info;
}
/**
* Returns the package dependency or {@code null} if not resolved.
*
* @return the package dependency.
*/
@Nullable
public PackageDependency getPackageDependency() {
return dependency;
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder("Dependency{");
sb.append("group='").append(group).append('\'');
sb.append(", groupId='").append(groupId).append('\'');
sb.append(", name='").append(name).append('\'');
sb.append(", artifactId='").append(artifactId).append('\'');
sb.append(", version='").append(version).append('\'');
sb.append('}');
return sb.toString();
}
}