com.synopsys.integration.blackduck.bdio2.model.ProjectInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blackduck-common Show documentation

A library for using various capabilities of Black Duck, notably the REST API and signature scanning.

There is a newer version: 66.2.19

/*
 * blackduck-common
 *
 * Copyright (c) 2023 Synopsys, Inc.
 *
 * Use subject to the terms and conditions of the Synopsys End User Software License and Maintenance Agreement. All rights reserved worldwide.
 */
package com.synopsys.integration.blackduck.bdio2.model;

import java.util.Optional;

import org.apache.commons.lang3.StringUtils;
import org.jetbrains.annotations.Nullable;

import com.synopsys.integration.bdio.model.dependency.ProjectDependency;
import com.synopsys.integration.util.NameVersion;

// Additional fields for the bdio-header.jsonld file
public class ProjectInfo {
    private final NameVersion nameVersion;
    @Nullable
    private final String projectGroup;
    @Nullable
    private final String correlationId;
    private final GitInfo gitInfo;

    public static ProjectInfo fromProjectDependency(ProjectDependency projectDependency) {
        String projectName = projectDependency.getExternalId().getName();
        String projectVersion = projectDependency.getExternalId().getVersion();
        String projectGroup = StringUtils.trimToNull(projectDependency.getExternalId().getGroup());
        // Today there is no GitInfo or CorrelationId, but perhaps those will be attached to the ProjectDependency class in the future. JM-04/2022
        return ProjectInfo.nameVersionGroup(new NameVersion(projectName, projectVersion), projectGroup);
    }

    public static ProjectInfo nameVersion(NameVersion nameVersion) {
        return ProjectInfo.nameVersionGit(nameVersion, GitInfo.none());
    }

    public static ProjectInfo nameVersionGroup(NameVersion nameVersion, String group) {
        return ProjectInfo.nameVersionGroupGit(nameVersion, group, GitInfo.none());
    }

    public static ProjectInfo nameVersionGit(NameVersion nameVersion, GitInfo gitInfo) {
        return ProjectInfo.nameVersionGroupGit(nameVersion, null, gitInfo);
    }

    public static ProjectInfo nameVersionGroupGit(NameVersion nameVersion, String group, GitInfo gitInfo) {
        return new ProjectInfo(nameVersion, group, null, gitInfo);
    }

    public ProjectInfo(
        NameVersion nameVersion,
        @Nullable String projectGroup,
        @Nullable String correlationId,
        GitInfo gitInfo
    ) {
        this.nameVersion = nameVersion;
        this.projectGroup = projectGroup;
        this.correlationId = correlationId;
        this.gitInfo = gitInfo;
    }

    public NameVersion getNameVersion() {
        return nameVersion;
    }

    public Optional getProjectGroup() {
        return Optional.ofNullable(projectGroup);
    }

    public Optional getCorrelationId() {
        return Optional.ofNullable(correlationId);
    }

    public GitInfo getGitInfo() {
        return gitInfo;
    }
}