Package com.xebialabs.xlrelease.api.v1

Interface RiskApi

  • All Superinterfaces:
    ApiService
    @Path("/api/v1/risks")
@Produces("application/json")
@Consumes("application/json")
public interface RiskApi
extends ApiService
    Operations on risk.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      com.xebialabs.xlrelease.risk.domain.RiskProfile copyRiskProfile​(com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
      Make copy of given risk profile.
      com.xebialabs.xlrelease.risk.domain.RiskProfile copyRiskProfile​(java.lang.String riskProfileId)
      Make copy of risk profile with given id.
      com.xebialabs.xlrelease.risk.domain.RiskProfile createRiskProfile​(com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
      Create risk profile.
      void deleteRiskProfile​(com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
      Delete risk profile.
      void deleteRiskProfile​(java.lang.String riskProfileId)
      Delete risk profile.
      java.util.List<com.xebialabs.xlrelease.risk.domain.riskassessors.RiskAssessor> getAllRiskAssessors()
      Returns the list of all risk assessor.
      com.xebialabs.xlrelease.risk.domain.Risk getRisk​(com.xebialabs.xlrelease.domain.Release release)
      Returns the release risk score.
      com.xebialabs.xlrelease.risk.domain.Risk getRisk​(java.lang.String riskId)
      Returns the release risk score.
      com.xebialabs.xlrelease.risk.configuration.RiskGlobalThresholds getRiskGlobalThresholds()
      Returns the global risk thresholds configuration.
      com.xebialabs.xlrelease.risk.domain.RiskProfile getRiskProfile​(java.lang.String riskProfileId)
      Returns the risk profile for the given identifier.
      com.xebialabs.xlrelease.risk.domain.RiskProfile getRiskProfileByTitle​(java.lang.String title)
      Returns the risk profile with the given title.
      java.util.List<com.xebialabs.xlrelease.risk.domain.RiskProfile> getRiskProfiles()
      Returns list of all risk profile configurations.
      default java.lang.String serviceName()  
      com.xebialabs.xlrelease.risk.configuration.RiskGlobalThresholds updateRiskGlobalThresholds​(com.xebialabs.xlrelease.risk.configuration.RiskGlobalThresholds thresholds)
      Update the global risk thresholds configuration.
      com.xebialabs.xlrelease.risk.domain.RiskProfile updateRiskProfile​(com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
      Update the risk profile.
      com.xebialabs.xlrelease.risk.domain.RiskProfile updateRiskProfile​(java.lang.String riskProfileId, com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
      Update the risk profile.

    • Method Detail

      • serviceName

        default java.lang.String serviceName()
        Specified by:
        serviceName in interface ApiService

      • getRisk

        @GET
@Path("/{riskId:.*/Risk}")
com.xebialabs.xlrelease.risk.domain.Risk getRisk​(@PathParam("riskId")
                                                 java.lang.String riskId)
        Returns the release risk score.
        Parameters:
        riskId - the full identifier of release risk score.
        Returns:
        risk.

      • getRisk

        com.xebialabs.xlrelease.risk.domain.Risk getRisk​(com.xebialabs.xlrelease.domain.Release release)
        Returns the release risk score.
        Parameters:
        release - the release from which you want risk score.
        Returns:
        risk.

      • getRiskGlobalThresholds

        @GET
@Path("/config")
com.xebialabs.xlrelease.risk.configuration.RiskGlobalThresholds getRiskGlobalThresholds()
        Returns the global risk thresholds configuration.
        Returns:
        global risk thresholds.

      • updateRiskGlobalThresholds

        @PUT
@Path("/config")
com.xebialabs.xlrelease.risk.configuration.RiskGlobalThresholds updateRiskGlobalThresholds​(com.xebialabs.xlrelease.risk.configuration.RiskGlobalThresholds thresholds)
        Update the global risk thresholds configuration.
        Parameters:
        thresholds - the updated global risk thresholds.
        Returns:
        global risk thresholds.

      • getRiskProfiles

        @GET
@Path("/profiles")
java.util.List<com.xebialabs.xlrelease.risk.domain.RiskProfile> getRiskProfiles()
        Returns list of all risk profile configurations.
        Returns:
        risk profiles list

      • getRiskProfile

        @GET
@Path("/profiles/{riskProfileId:.*/RiskProfile[^/]*|new}")
com.xebialabs.xlrelease.risk.domain.RiskProfile getRiskProfile​(@PathParam("riskProfileId")
                                                               java.lang.String riskProfileId)
        Returns the risk profile for the given identifier.
        Parameters:
        riskProfileId - the full identifier of risk profile.
        Returns:
        risk profile.

      • getRiskProfileByTitle

        com.xebialabs.xlrelease.risk.domain.RiskProfile getRiskProfileByTitle​(java.lang.String title)
        Returns the risk profile with the given title.
        Parameters:
        title - title of the risk profile.
        Returns:
        risk profile.

      • updateRiskProfile

        @PUT
@Path("/profiles/{riskProfileId:.*/RiskProfile[^/]*}")
com.xebialabs.xlrelease.risk.domain.RiskProfile updateRiskProfile​(@PathParam("riskProfileId")
                                                                  java.lang.String riskProfileId,
                                                                  com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
        Update the risk profile.
        Parameters:
        riskProfileId - the full identifier of risk profile.
        riskProfile - the updated risk profile.
        Returns:
        the updated risk profile.

      • updateRiskProfile

        com.xebialabs.xlrelease.risk.domain.RiskProfile updateRiskProfile​(com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
        Update the risk profile.
        Parameters:
        riskProfile - the updated risk profile.
        Returns:
        the updated risk profile.

      • createRiskProfile

        @POST
@Path("/profiles")
com.xebialabs.xlrelease.risk.domain.RiskProfile createRiskProfile​(com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
        Create risk profile.
        Parameters:
        riskProfile - the new risk profile.
        Returns:
        risk profile.

      • deleteRiskProfile

        @DELETE
@Path("/profiles/{riskProfileId:.*/RiskProfile[^/]*}")
void deleteRiskProfile​(@PathParam("riskProfileId")
                       java.lang.String riskProfileId)
        Delete risk profile.
        Parameters:
        riskProfileId - the full identifier of risk profile.

      • deleteRiskProfile

        void deleteRiskProfile​(com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
        Delete risk profile.
        Parameters:
        riskProfile - the risk profile you would like to delete.

      • copyRiskProfile

        @POST
@Path("/profiles/{riskProfileId:.*/RiskProfile[^/]*}/copy")
com.xebialabs.xlrelease.risk.domain.RiskProfile copyRiskProfile​(@PathParam("riskProfileId")
                                                                java.lang.String riskProfileId)
        Make copy of risk profile with given id.
        Parameters:
        riskProfileId - the full identifier of risk profile.
        Returns:
        risk profile.

      • copyRiskProfile

        com.xebialabs.xlrelease.risk.domain.RiskProfile copyRiskProfile​(com.xebialabs.xlrelease.risk.domain.RiskProfile riskProfile)
        Make copy of given risk profile.
        Parameters:
        riskProfile - the risk profile from which a copy will be created.
        Returns:
        risk profile.

      • getAllRiskAssessors

        @GET
@Path("/assessors")
java.util.List<com.xebialabs.xlrelease.risk.domain.riskassessors.RiskAssessor> getAllRiskAssessors()
        Returns the list of all risk assessor.
        Returns:
        list of all risk assessor.