org.jboss.pnc.facade.providers.api.BuildProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of facade Show documentation
Common module for front-facing implementations like REST.
There is a newer version: 3.0.4
/**
 * JBoss, Home of Professional Open Source.
 * Copyright 2014-2022 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed 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.jboss.pnc.facade.providers.api;

import org.jboss.pnc.dto.Build;
import org.jboss.pnc.dto.BuildConfigurationRevision;
import org.jboss.pnc.dto.BuildRef;
import org.jboss.pnc.dto.insights.BuildRecordInsights;
import org.jboss.pnc.dto.response.Graph;
import org.jboss.pnc.dto.response.Page;
import org.jboss.pnc.dto.response.RunningBuildCount;
import org.jboss.pnc.dto.response.SSHCredentials;
import org.jboss.pnc.enums.BuildStatus;
import org.jboss.pnc.facade.validation.EmptyEntityException;
import org.jboss.pnc.model.Base32LongID;

import java.net.URI;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;

public interface BuildProvider extends Provider {

    /**
     * Get the internal scm archive link for a build record. If the scm revision is not specified in the build record
     * due to a failure, it will return null
     *
     * @param buildId
     *
     * @return Uri of the internal scm archive link to download
     */
    URI getInternalScmArchiveLink(String buildId);

    void addAttribute(String buildId, String key, String value);

    void removeAttribute(String buildId, String key);

    BuildConfigurationRevision getBuildConfigurationRevision(String buildId);

    boolean delete(String buildId, String callback);

    SSHCredentials getSshCredentials(String buildId);

    Page getAllIndependentTemporaryOlderThanTimestamp(
            int pageIndex,
            int pageSize,
            String sort,
            String q,
            long timestamp);

    Page getBuilds(BuildPageInfo pageInfo);

    Page getBuildsForMilestone(BuildPageInfo pageInfo, String milestoneId);

    Page getBuildsForProject(BuildPageInfo pageInfo, String projectId);

    Page getBuildsForBuildConfiguration(BuildPageInfo pageInfo, String buildConfigurationId);

    Page getBuildsForUser(BuildPageInfo pageInfo, String userId);

    Page getBuildsForGroupConfiguration(BuildPageInfo pageInfo, String groupConfigurationId);

    Page getBuildsForGroupBuild(BuildPageInfo pageInfo, String groupBuildId);

    Page getBuildsForArtifact(int pageIndex, int pageSize, String sortingRsql, String query, String artifactId);

    Page getDependantBuildsForArtifact(
            int pageIndex,
            int pageSize,
            String sortingRsql,
            String query,
            String artifactId);

    Graph getBuildGraphForGroupBuild(String id);

    /**
     *
     * @param buildId
     * @return
     * @throws EmptyEntityException when there is no record for given id
     */
    Graph getDependencyGraph(String buildId);

    void setBuiltArtifacts(String buildId, List artifactIds);

    void setDependentArtifacts(String buildId, List artifactIds);

    Page getByAttribute(BuildPageInfo pageInfo, Map attributeConstraints);

    /**
     * Return count of current running builds
     *
     * @return count
     */
    RunningBuildCount getRunningCount();

    Set getBuiltArtifactIds(String buildId);

    Page getAllBuildRecordInsightsNewerThanTimestamp(
            int pageIndex,
            int pageSize,
            Date lastupdatetime);
}