io.github.chains_project.maven_lockfile.graph.DependencyNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-lockfile Show documentation
This plugin is a state-of-the-art solution that can be used to validate the integrity of a maven repository. It does this by generating a lock file that contains the checksums of all the artifacts in the repository. The lock file can then be used to validate the integrity of the repository. This guards the supply chain against malicious actors that might tamper with the artifacts in the repository.
There is a newer version: 5.3.5
Show newest version
package io.github.chains_project.maven_lockfile.graph;

import com.google.gson.annotations.Expose;
import io.github.chains_project.maven_lockfile.data.ArtifactId;
import io.github.chains_project.maven_lockfile.data.Classifier;
import io.github.chains_project.maven_lockfile.data.GroupId;
import io.github.chains_project.maven_lockfile.data.MavenScope;
import io.github.chains_project.maven_lockfile.data.VersionNumber;
import java.util.*;
import javax.annotation.Nullable;

/**
 * This class represents a node in the dependency graph. It contains the artifactId, groupId and version  of the dependency.
 * It also contains a reference to the parent node.
 */
public class DependencyNode implements Comparable {

    private final GroupId groupId;
    private final ArtifactId artifactId;
    private final VersionNumber version;
    private final Classifier classifier;
    private final String checksumAlgorithm;
    private final String checksum;
    private final MavenScope scope;

    @Nullable
    private String selectedVersion;

    @Nullable
    private boolean included;

    NodeId id;

    @Expose(serialize = false, deserialize = false)
    private NodeId parent;

    private final Set children;

    // kept for backward compability, following https://github.com/chains-project/maven-lockfile/pull/803
    DependencyNode(
            ArtifactId artifactId,
            GroupId groupId,
            VersionNumber version,
            MavenScope scope,
            String checksumAlgorithm,
            String checksum) {
        this(artifactId, groupId, version, null, scope, checksumAlgorithm, checksum);
    }

    DependencyNode(
            ArtifactId artifactId,
            GroupId groupId,
            VersionNumber version,
            Classifier classifier,
            MavenScope scope,
            String checksumAlgorithm,
            String checksum) {
        this.artifactId = artifactId;
        this.groupId = groupId;
        this.version = version;
        this.classifier = classifier;
        this.checksumAlgorithm = checksumAlgorithm;
        this.checksum = checksum;
        this.children = new TreeSet<>(Comparator.comparing(DependencyNode::getChecksum));
        this.id = new NodeId(groupId, artifactId, version);
        this.scope = scope;
    }
    /**
     * @return the artifactId
     */
    public ArtifactId getArtifactId() {
        return artifactId;
    }
    /**
     * @return the groupId
     */
    public GroupId getGroupId() {
        return groupId;
    }
    /**
     * @return the parent
     */
    public NodeId getParent() {
        return parent;
    }
    /**
     * @return the version
     */
    public VersionNumber getVersion() {
        return version;
    }
    /**
     * @return the classifier or null if not present
     */
    public Classifier getClassifier() {
        return classifier;
    }
    /**
     * @return the scope
     */
    public MavenScope getScope() {
        return scope;
    }

    void addChild(DependencyNode child) {
        children.add(child);
        child.setParent(id);
        if (!child.parent.equals(id)) {
            throw new IllegalStateException("Child node has wrong parent");
        }
    }

    void setParent(NodeId parent) {
        this.parent = parent;
    }

    /**
     * @return the children
     */
    public Set getChildren() {
        return Collections.unmodifiableSet(children);
    }

    /**
     * @return the checksum
     */
    public String getChecksum() {
        return checksum;
    }
    /**
     * @return the checksumAlgorithm
     */
    public String getChecksumAlgorithm() {
        return checksumAlgorithm;
    }
    /**
     * @param baseVersion the baseVersion to set
     */
    public void setSelectedVersion(String baseVersion) {
        this.selectedVersion = baseVersion;
    }
    /**
     * @return the baseVersion
     */
    public String getSelectedVersion() {
        return selectedVersion;
    }

    /**
     * @param included the state of inclusion
     */
    public void setIncluded(boolean included) {
        this.included = included;
    }

    /**
     * @return the state of inclusion
     */
    public boolean isIncluded() {
        return included;
    }

    @Override
    public int hashCode() {
        return Objects.hash(
                groupId,
                artifactId,
                version,
                classifier,
                checksumAlgorithm,
                checksum,
                scope,
                selectedVersion,
                id,
                parent,
                children);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof DependencyNode)) {
            return false;
        }
        DependencyNode other = (DependencyNode) obj;
        return Objects.equals(groupId, other.groupId)
                && Objects.equals(artifactId, other.artifactId)
                && Objects.equals(version, other.version)
                && Objects.equals(classifier, other.classifier)
                && Objects.equals(checksumAlgorithm, other.checksumAlgorithm)
                && Objects.equals(checksum, other.checksum)
                && scope == other.scope
                && Objects.equals(selectedVersion, other.selectedVersion)
                && Objects.equals(id, other.id)
                && Objects.equals(parent, other.parent)
                && Objects.equals(children, other.children);
    }

    @Override
    public int compareTo(DependencyNode o) {
        int groupIdCompare = groupId.compareTo(o.groupId);
        if (groupIdCompare != 0) {
            return groupIdCompare;
        }
        int artifactIdCompare = artifactId.compareTo(o.artifactId);
        if (artifactIdCompare != 0) {
            return artifactIdCompare;
        }
        int versionCompare = version.compareTo(o.version);
        if (versionCompare != 0) {
            return versionCompare;
        }
        if (classifier == null) {
            if (o.classifier == null) {
                return 0;
            }
            return -1;
        }
        if (o.classifier == null) {
            return 1;
        }
        return classifier.compareTo(o.classifier);
    }

    @Override
    public String toString() {
        return "DependencyNode [groupId=" + groupId + ", artifactId=" + artifactId + ", version=" + version
                + ", classifier=" + classifier + ", checksumAlgorithm=" + checksumAlgorithm + ", checksum=" + checksum
                + ", scope=" + scope + ", selectedVersion=" + selectedVersion + ", id=" + id + ", parent=" + parent
                + ", children=" + children + "]";
    }
}