Package com.xebialabs.xlrelease.api.v1

Interface DeliveryPatternApi

  • All Superinterfaces:
    ApiService
    @Path("/api/v1/delivery-patterns")
@Produces("application/json")
@Consumes("application/json")
public interface DeliveryPatternApi
extends ApiService
    Operations on release deliveries.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      boolean checkTitleUnique​(com.xebialabs.xlrelease.api.v1.forms.ValidatePattern validation)  
      com.xebialabs.xlrelease.domain.delivery.Delivery createDeliveryFromPattern​(java.lang.String patternId, com.xebialabs.xlrelease.api.v1.forms.CreateDelivery createDelivery)
      Creates a delivery from a delivery pattern.
      com.xebialabs.xlrelease.domain.delivery.Delivery createPattern​(com.xebialabs.xlrelease.domain.delivery.Delivery pattern)
      Creates a new delivery pattern.
      com.xebialabs.xlrelease.domain.delivery.Stage createStage​(java.lang.String patternId, com.xebialabs.xlrelease.api.v1.forms.CreateDeliveryStage form)  
      com.xebialabs.xlrelease.domain.delivery.Stage createStage​(java.lang.String patternId, com.xebialabs.xlrelease.domain.delivery.Stage stage)
      Adds a stage to a pattern.
      com.xebialabs.xlrelease.domain.delivery.Stage createStage​(java.lang.String patternId, com.xebialabs.xlrelease.domain.delivery.Stage stage, java.lang.Integer position)  
      com.xebialabs.xlrelease.domain.delivery.TrackedItem createTrackedItem​(java.lang.String patternId, com.xebialabs.xlrelease.domain.delivery.TrackedItem item)
      Adds a tracked item to a delivery pattern.
      com.xebialabs.xlrelease.domain.delivery.Transition createTransition​(java.lang.String stageId, com.xebialabs.xlrelease.domain.delivery.Transition transition)
      Adds a transition to a stage in a delivery pattern.
      void deletePattern​(java.lang.String patternId)
      Deletes a delivery pattern.
      void deleteStage​(java.lang.String stageId)
      Deletes a stage in a delivery pattern.
      void deleteTrackedItem​(java.lang.String itemId)
      Deletes a tracked item.
      void deleteTransition​(java.lang.String transitionId)
      Deletes a transition in a delivery pattern.
      com.xebialabs.xlrelease.domain.delivery.Delivery duplicatePattern​(java.lang.String patternId, com.xebialabs.xlrelease.api.v1.forms.DuplicateDeliveryPattern duplicateDeliveryPattern)  
      com.xebialabs.xlrelease.domain.delivery.Delivery getPattern​(java.lang.String patternId)
      Returns a delivery pattern by ID.
      com.xebialabs.xlrelease.domain.delivery.Delivery getPatternByIdOrTitle​(java.lang.String patternIdOrTitle)
      Returns a delivery pattern by ID or title.
      java.util.List<com.xebialabs.xlrelease.domain.delivery.Stage> getStages​(java.lang.String patternId)
      Returns the stages in a given delivery pattern.
      java.util.List<com.xebialabs.xlrelease.domain.delivery.TrackedItem> getTrackedItems​(java.lang.String patternId)
      Returns the tracked items associated with given delivery pattern.
      java.util.List<com.xebialabs.xlrelease.domain.delivery.Delivery> searchPatterns​(com.xebialabs.xlrelease.api.v1.forms.DeliveryPatternFilters filters)
      Search delivery patterns by filters with default pagination.
      java.util.List<com.xebialabs.xlrelease.domain.delivery.Delivery> searchPatterns​(com.xebialabs.xlrelease.api.v1.forms.DeliveryPatternFilters filters, java.lang.Long page, java.lang.Long resultsPerPage)
      Search delivery patterns by filters.
      default java.lang.String serviceName()  
      com.xebialabs.xlrelease.domain.delivery.Delivery updatePattern​(com.xebialabs.xlrelease.domain.delivery.Delivery pattern)
      Updates a delivery pattern.
      com.xebialabs.xlrelease.domain.delivery.Delivery updatePattern​(java.lang.String patternId, com.xebialabs.xlrelease.domain.delivery.Delivery pattern)
      Updates a delivery pattern.
      com.xebialabs.xlrelease.domain.delivery.Stage updateStage​(com.xebialabs.xlrelease.domain.delivery.Stage stage)
      Updates a stage in a delivery pattern.
      com.xebialabs.xlrelease.domain.delivery.Stage updateStage​(java.lang.String stageId, com.xebialabs.xlrelease.domain.delivery.Stage stage)
      Updates a stage in a delivery pattern.
      com.xebialabs.xlrelease.domain.delivery.Stage updateStageFromBatch​(java.lang.String stageId, com.xebialabs.xlrelease.domain.delivery.Stage stage)
      Updates a stage in a delivery pattern from as-code.
      com.xebialabs.xlrelease.domain.delivery.TrackedItem updateTrackedItem​(com.xebialabs.xlrelease.domain.delivery.TrackedItem item)
      Updates a tracked item.
      com.xebialabs.xlrelease.domain.delivery.TrackedItem updateTrackedItem​(java.lang.String itemId, com.xebialabs.xlrelease.domain.delivery.TrackedItem item)
      Updates a tracked item.
      com.xebialabs.xlrelease.domain.delivery.Transition updateTransition​(com.xebialabs.xlrelease.domain.delivery.Transition transition)
      Updates a transition in a delivery pattern.
      com.xebialabs.xlrelease.domain.delivery.Transition updateTransition​(java.lang.String transitionId, com.xebialabs.xlrelease.domain.delivery.Transition transition)
      Updates a transition in a delivery pattern.

    • Method Detail

      • serviceName

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

      • createPattern

        @POST
com.xebialabs.xlrelease.domain.delivery.Delivery createPattern​(com.xebialabs.xlrelease.domain.delivery.Delivery pattern)
        Creates a new delivery pattern.
        Parameters:
        pattern - the delivery pattern to be created.
        Returns:
        the created delivery pattern.

      • getPattern

        @GET
@Path("/{patternId:.*Delivery[^/]*}")
com.xebialabs.xlrelease.domain.delivery.Delivery getPattern​(@PathParam("patternId")
                                                            java.lang.String patternId)
        Returns a delivery pattern by ID.
        Parameters:
        patternId - the pattern identifier.
        Returns:
        the pattern which has the given identifier.

      • getPatternByIdOrTitle

        @GET
@Path("/{patternIdOrTitle}")
com.xebialabs.xlrelease.domain.delivery.Delivery getPatternByIdOrTitle​(@PathParam("patternIdOrTitle")
                                                                       java.lang.String patternIdOrTitle)
        Returns a delivery pattern by ID or title.
        Parameters:
        patternIdOrTitle - the pattern ID or title.
        Returns:
        the pattern which has the given ID or the given title.

      • checkTitleUnique

        @POST
@Path("/checkTitle")
boolean checkTitleUnique​(com.xebialabs.xlrelease.api.v1.forms.ValidatePattern validation)

      • updatePattern

        @PUT
@Path("/{patternId:.*Delivery[^/]*}")
com.xebialabs.xlrelease.domain.delivery.Delivery updatePattern​(@PathParam("patternId")
                                                               java.lang.String patternId,
                                                               com.xebialabs.xlrelease.domain.delivery.Delivery pattern)
        Updates a delivery pattern.
        Parameters:
        patternId - the pattern identifier.
        pattern - new contents of the pattern.
        Returns:
        the updated pattern.

      • updatePattern

        com.xebialabs.xlrelease.domain.delivery.Delivery updatePattern​(com.xebialabs.xlrelease.domain.delivery.Delivery pattern)
        Updates a delivery pattern.
        Parameters:
        pattern - new contents of the pattern.
        Returns:
        the updated pattern.

      • deletePattern

        @DELETE
@Path("/{patternId:.*Delivery[^/]*}")
void deletePattern​(@PathParam("patternId")
                   java.lang.String patternId)
        Deletes a delivery pattern.
        Parameters:
        patternId - the pattern identifier.

      • duplicatePattern

        @POST
@Path("/{patternId:.*Delivery[^/]*}/duplicate")
com.xebialabs.xlrelease.domain.delivery.Delivery duplicatePattern​(@PathParam("patternId")
                                                                  java.lang.String patternId,
                                                                  com.xebialabs.xlrelease.api.v1.forms.DuplicateDeliveryPattern duplicateDeliveryPattern)

      • createDeliveryFromPattern

        @POST
@Path("/{patternId:.*Delivery[^/]*}/create")
com.xebialabs.xlrelease.domain.delivery.Delivery createDeliveryFromPattern​(@PathParam("patternId")
                                                                           java.lang.String patternId,
                                                                           com.xebialabs.xlrelease.api.v1.forms.CreateDelivery createDelivery)
        Creates a delivery from a delivery pattern.
        Parameters:
        patternId - the identifier of the delivery pattern the delivery is based on.
        createDelivery - the parameters for the new delivery.
        Returns:
        the newly created delivery.

      • searchPatterns

        @POST
@Path("search")
java.util.List<com.xebialabs.xlrelease.domain.delivery.Delivery> searchPatterns​(com.xebialabs.xlrelease.api.v1.forms.DeliveryPatternFilters filters,
                                                                                @DefaultValue("0") @QueryParam("page")
                                                                                java.lang.Long page,
                                                                                @DefaultValue("100") @QueryParam("resultsPerPage")
                                                                                java.lang.Long resultsPerPage)
        Search delivery patterns by filters.
        Parameters:
        filters - the search criteria.
        page - the page of results to return. Default value is 0.
        resultsPerPage - the number of results per page. Default and maximum value is 100.
        Returns:
        the list of matching delivery patterns.

      • searchPatterns

        java.util.List<com.xebialabs.xlrelease.domain.delivery.Delivery> searchPatterns​(com.xebialabs.xlrelease.api.v1.forms.DeliveryPatternFilters filters)
        Search delivery patterns by filters with default pagination.
        Parameters:
        filters - the search criteria.
        Returns:
        the list of matching delivery patterns.

      • createStage

        @POST
@Path("/{patternId:.*Delivery[^/]*}/stages")
com.xebialabs.xlrelease.domain.delivery.Stage createStage​(@PathParam("patternId")
                                                          java.lang.String patternId,
                                                          com.xebialabs.xlrelease.domain.delivery.Stage stage)
        Adds a stage to a pattern.
        Parameters:
        patternId - the pattern identifier.
        stage - the stage to be added to the delivery pattern.
        Returns:
        the created stage.

      • createStage

        @POST
@Path("/{patternId:.*Delivery[^/]*}/stages/{position:\\d+}")
com.xebialabs.xlrelease.domain.delivery.Stage createStage​(@PathParam("patternId")
                                                          java.lang.String patternId,
                                                          com.xebialabs.xlrelease.domain.delivery.Stage stage,
                                                          @PathParam("position")
                                                          java.lang.Integer position)

      • createStage

        @POST
@Path("/{patternId:.*Delivery[^/]*}/createStage")
com.xebialabs.xlrelease.domain.delivery.Stage createStage​(@PathParam("patternId")
                                                          java.lang.String patternId,
                                                          com.xebialabs.xlrelease.api.v1.forms.CreateDeliveryStage form)

      • getStages

        @GET
@Path("/{patternId:.*Delivery[^/]*}/stages")
java.util.List<com.xebialabs.xlrelease.domain.delivery.Stage> getStages​(@PathParam("patternId")
                                                                        java.lang.String patternId)
        Returns the stages in a given delivery pattern.
        Parameters:
        patternId - the pattern identifier.
        Returns:
        stages in the delivery pattern.

      • updateStage

        com.xebialabs.xlrelease.domain.delivery.Stage updateStage​(com.xebialabs.xlrelease.domain.delivery.Stage stage)
        Updates a stage in a delivery pattern.
        Parameters:
        stage - new contents of the stage.
        Returns:
        the updated stage.

      • updateStage

        @PUT
@Path("/{stageId:.*Stage[^/]*}")
com.xebialabs.xlrelease.domain.delivery.Stage updateStage​(@PathParam("stageId")
                                                          java.lang.String stageId,
                                                          com.xebialabs.xlrelease.domain.delivery.Stage stage)
        Updates a stage in a delivery pattern.
        Parameters:
        stageId - the full stage identifier.
        stage - new contents of the stage.
        Returns:
        the updated stage.

      • updateStageFromBatch

        @PUT
@Path("/{stageId:.*Stage[^/]*}/batched")
com.xebialabs.xlrelease.domain.delivery.Stage updateStageFromBatch​(@PathParam("stageId")
                                                                   java.lang.String stageId,
                                                                   com.xebialabs.xlrelease.domain.delivery.Stage stage)
        Updates a stage in a delivery pattern from as-code.
        Parameters:
        stageId - the full stage identifier.
        stage - new contents of the stage.
        Returns:
        the updated stage.

      • deleteStage

        @DELETE
@Path("/{stageId:.*Stage[^/]*}")
void deleteStage​(@PathParam("stageId")
                 java.lang.String stageId)
        Deletes a stage in a delivery pattern.
        Parameters:
        stageId - the full stage identifier.

      • createTransition

        @POST
@Path("/{stageId:.*Stage[^/]*}/transitions")
com.xebialabs.xlrelease.domain.delivery.Transition createTransition​(@PathParam("stageId")
                                                                    java.lang.String stageId,
                                                                    com.xebialabs.xlrelease.domain.delivery.Transition transition)
        Adds a transition to a stage in a delivery pattern.
        Parameters:
        stageId - the full stage identifier.
        transition - the transition to be added to a stage.
        Returns:
        the created transition.

      • updateTransition

        @PUT
@Path("/{transitionId:.*Transition[^/]*}")
com.xebialabs.xlrelease.domain.delivery.Transition updateTransition​(@PathParam("transitionId")
                                                                    java.lang.String transitionId,
                                                                    com.xebialabs.xlrelease.domain.delivery.Transition transition)
        Updates a transition in a delivery pattern.
        Parameters:
        transitionId - the full transition identifier.
        transition - new contents of the transition.
        Returns:
        the updated transition.

      • updateTransition

        com.xebialabs.xlrelease.domain.delivery.Transition updateTransition​(com.xebialabs.xlrelease.domain.delivery.Transition transition)
        Updates a transition in a delivery pattern.
        Parameters:
        transition - new contents of the transition.
        Returns:
        the updated transition.

      • deleteTransition

        @DELETE
@Path("/{transitionId:.*Transition[^/]*}")
void deleteTransition​(@PathParam("transitionId")
                      java.lang.String transitionId)
        Deletes a transition in a delivery pattern.
        Parameters:
        transitionId - the full transition identifier.

      • createTrackedItem

        @POST
@Path("/{patternId:.*Delivery[^/]*}/tracked-items")
com.xebialabs.xlrelease.domain.delivery.TrackedItem createTrackedItem​(@PathParam("patternId")
                                                                      java.lang.String patternId,
                                                                      com.xebialabs.xlrelease.domain.delivery.TrackedItem item)
        Adds a tracked item to a delivery pattern.
        Parameters:
        patternId - the pattern identifier.
        item - the item to be added to the delivery pattern.
        Returns:
        the created item.

      • getTrackedItems

        @GET
@Path("/{patternId:.*Delivery[^/]*}/tracked-items")
java.util.List<com.xebialabs.xlrelease.domain.delivery.TrackedItem> getTrackedItems​(@PathParam("patternId")
                                                                                    java.lang.String patternId)
        Returns the tracked items associated with given delivery pattern.
        Parameters:
        patternId - the pattern identifier.
        Returns:
        tracked items associated with the delivery pattern.

      • updateTrackedItem

        @PUT
@Path("/{itemId:.*TrackedItem[^/]*}")
com.xebialabs.xlrelease.domain.delivery.TrackedItem updateTrackedItem​(@PathParam("itemId")
                                                                      java.lang.String itemId,
                                                                      com.xebialabs.xlrelease.domain.delivery.TrackedItem item)
        Updates a tracked item.
        Parameters:
        itemId - the full item identifier.
        item - new contents of the item.
        Returns:
        the updated item.

      • updateTrackedItem

        com.xebialabs.xlrelease.domain.delivery.TrackedItem updateTrackedItem​(com.xebialabs.xlrelease.domain.delivery.TrackedItem item)
        Updates a tracked item.
        Parameters:
        item - new contents of the item.
        Returns:
        the updated item.

      • deleteTrackedItem

        @DELETE
@Path("/{itemId:.*TrackedItem[^/]*}")
void deleteTrackedItem​(@PathParam("itemId")
                       java.lang.String itemId)
        Deletes a tracked item.
        Parameters:
        itemId - the full item identifier.